conventional-changelog/standard-version

docs: add detailed documentation in a docs/ folder

オープン

#226 opened on 2017/11/29

GitHub で見る
 (0 件のコメント) (5 件のリアクション) (0 人の担当者)JavaScript (825 件のフォーク)batch import
enhancementhelp wanted

Repository metrics

Stars
 (7,442 個のスター)
PR merge metrics
 (PR metrics pending)

説明

I think standard-version would benefit from an approach I recently took with yargs, introducing additional detailed help information in a docs/ folder. Sections that immediately come to mind:

  • docs/advanced.md: advanced tips and tricks (generating a CHANGELOG from scratch, real-world examples of lifecycle scripts).
  • docs/FAQ.md: frequently asked questions about conventional-commits, e.g., why are some commits in the CHANGELOG and others not?

CC: @stevemao @nexdrew

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

調査方針
リポジトリのルートに docs/ フォルダを作成します。docs/advanced.md には、standard version の高度なヒントとコツ（例：CHANGELOG をゼロから生成する方法、ライフサイクルスクリプトの実例）を追加します。docs/FAQ.md には、conventional commits に関するよくある質問（なぜ一部のコミットは CHANGELOG に表示され、その他は表示されないのか）を追加します。両方のファイルは Markdown 形式にしてください。
技術スタック
javascript
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GitMarkdown
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90