jquery/sizzle

Reorganize docs

Open

#366 opened on 2015年11月11日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)JavaScript (991 forks)batch import
help wanted

Repository metrics

Stars
 (6,264 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

README.md should focus first (and most strongly) on using Sizzle, since it gets rendered into https://www.npmjs.com/package/sizzle . This includes API documentation currently in the wiki.

Remaining contents would be better placed in CONTRIBUTING.md and linked to from README.md.

コントリビューターガイド

調査方針
APIドキュメントをwikiからREADME.mdに移し、使用方法に焦点を当ててください。残りの開発および貢献ガイドラインをCONTRIBUTING.mdに移動し、README.mdがCONTRIBUTING.mdにリンクするようにしてください。
技術スタック
javascript
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90