guyzmo/git-repo

Write more thorough documentation

Open

#146 opened on 2017年3月21日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Python (86 forks)batch import
enhancementgood first issuehelp wanted

Repository metrics

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

説明

  • make a full sphinx documentation for the project with
    • proper manual on how to use it (and why not generate a manpage?)
    • documentation of internals
    • upload of all of it on readthedocs

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

調査方針
Sphinxドキュメンテーションツールを学び、プロジェクト構造を調べ、使用法と内部のドキュメントを書き始め、ReadTheDocsにアップロードします。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonSphinx
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75