docs: ドキュメントの変更
docsタイプを使ったドキュメントのみの変更のコミットメッセージの書き方を学びます。README更新、APIドキュメント、インラインコメント、貢献ガイドを網羅します。
Type Examples
詳細な説明
docs コミットタイプ
docsタイプは、ドキュメントのみを変更するコミットに使用します。READMEファイル、APIドキュメント、インラインコードコメント、貢献ガイド、変更ログ、その他アプリケーションの実行時動作に影響しないすべての記述コンテンツが含まれます。Semantic Versioningでは、docsコミットはソフトウェア自体を変更しないため、バージョンバンプをトリガーしません。
メッセージの例
docs: add API authentication section to README
docs: fix typo in contributing guidelines
docs(api): document rate limiting headers
docsを使うタイミング
以下の場合にdocsを使用します：
- READMEやその他のmarkdownファイルを更新する
- JSDoc、Javadoc、docstringコメントを追加・改善する
- APIリファレンスドキュメントを更新する
- 貢献ガイドやセットアップガイドを修正する
- ドキュメントの誤字、文法、フォーマットを修正する
- アーキテクチャ決定記録（ADR）を追加する
docsを使わないケース
コードとドキュメントの両方を変更するコミットの場合、コード変更に一致するタイプを使用します。例えば、新機能を追加してREADMEを更新する場合はfeatを使い、ボディでドキュメントの更新に触れます。
スコープ付き
スコープを追加するとどのドキュメントが更新されたか明確になります：
docs(changelog): add entries for v2.3.0 release
docs(readme): add Docker deployment instructions
これはモノレポや複数のドキュメント領域を持つプロジェクトで特に便利です。
ユースケース
Dockerベースの開発用の新しいセットアップ手順を含むようにプロジェクトのREADMEを更新しました。コード自体はまったく変更されておらず、ドキュメントファイルのみです。レビュアーやCIパイプラインがそれに応じて処理できるよう、ドキュメントのみの変更であることを明確にするコミットメッセージが必要です。