streamich/git-cz

Docs cleanup

オープン

#121 opened on 2020/01/16

GitHub で見る
 (1 件のコメント) (0 件のリアクション) (0 人の担当者)JavaScript (111 件のフォーク)github user discovery
good first issuehelp wanted📓 documentation

Repository metrics

Stars
 (1,872 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

  • Move most of the contents of README.md into separate files:
    • /docs/Installation.md
    • /docs/Configuration.md
    • add /docs/CLI-options.md
    • /docs/Semantic-commits.md
  • Keep in README.md
    • Screenshot
    • Add more badges
    • Quick-start comand npx git-cz
    • Links to docs in /docs folder

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

調査方針
チェックリストに従って個別のドキュメントファイルを作成し、README.mdにそれらへのリンクを追加します。
技術スタック
javascript
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GitMarkdown
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85