ドキュメントコミット（docsタイプ）
ドキュメントのみの変更に対するdocsコミットメッセージの書き方。Conventional Commitsでdocsタイプを使用するタイミングを理解します。
Valid Formats
詳細な説明
docsタイプ
docsタイプは、コミットがドキュメントののみを変更する場合に使用されます。READMEファイル、APIドキュメント、インラインコードコメント、ガイド、設定ファイルのコメントが含まれます。ドキュメントの変更はソフトウェアの実行時の動作に影響しないため、標準的なsemantic-release設定ではバージョンバンプをトリガーしません。
例
docs: update API authentication guide
docs(readme): add installation instructions for Windows
docs(api): fix typo in getUserById endpoint description
docsと他のタイプの使い分け
| 変更 | タイプ |
|---|---|
| READMEの更新 | docs |
| JSDocコメントの追加 | docs |
| コードコメントのタイポ修正 | docs |
| バグを引き起こすタイポの修正 | fix |
| 新しいAPIエンドポイント + ドキュメントの追加 | feat |
| コードのリファクタリング + ドキュメントの更新 | refactor |
重要なルール：コミットがドキュメントのみを変更する場合はdocsを使用します。コードとドキュメントを一緒に変更する場合は、コード変更を説明するタイプを使用します。
変更ログの動作
ほとんどの変更ログジェネレーターは、docsコミットを完全に除外するか、別の「ドキュメント」セクションにグループ化します。これにより、変更ログはユーザー向けの変更に焦点を当てつつ、Git履歴でドキュメントの改善を追跡できます。
スタイルのヒント
- 命令形を使用：「update guide」であり「updated guide」ではありません。
- 具体的に：「update API authentication guide」は「update docs」よりも優れています。
- ドキュメントが特定のモジュールに属する場合はスコープを追加してください。
ユースケース
READMEの更新、APIドキュメントの変更、インラインコメントの改善、およびアプリケーションの実行時の動作を変更せずにドキュメントファイルのみを変更するあらゆる変更にdocsコミットを使用します。