FGRibreau/check-build

Documentation

Open

#8 opened on 2014年11月3日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)JavaScript (33 forks)batch import
enhancementhelp wanted

Repository metrics

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

説明

Develop a tool like "check-docs" or "dox-check" to check that at least X% functions are documented per files. Something like jsinspect but for documentation.

Then add an interface to check-build.

PR are welcome for this!

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

調査方針
ドキュメントカバレッジ（例：ファイルごとに少なくともX%の関数が文書化されている）をチェックするツールを開発し、check build インターフェースに統合してください。
技術スタック
javascriptnodejs
領域
developer experiencetoolingbuild system
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Node.jsnpm
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75