これはAngularのコミットメッセージ形式、及びAngular.jsのコミットガイドラインを参考に制定しています。
Gitのコミットメッセージの形式を厳密に制定します。これはコミットの可読性向上を目的としています。
コミットメッセージは、Header、Body、Footerから構成されます。
<Header>
<空行>
<Body>
<空行>
<Footer>
Headerは必須項目であり、コミットメッセージのHeaderに準拠して記述する必要があります。
Bodyはdocsタイプを除いたすべてのコミットで必須項目です。これを記述する場合、最低でも20文字程度の長さにしつつコミットメッセージのBodyに準拠して記述する必要があります。
Footerは任意項目です。コミットメッセージのFooterに準拠して記述する必要があります。
<タイプ>: <概要>
│ │
│ └─⫸ 概要。句読点は含まない。
│
└─⫸ コミットタイプ: feat|fix|docs|style|refactor|test|chore
タイプ、概要ともに必須項目です。
以下のいずれかを使用しなければなりません。
- feat: 新規機能の追加
- fix: バグ修正
- docs: ドキュメントのみの変更
- style: 内容の変更がないコードの変更 (空白、フォーマット、セミコロン抜けの修正など)
- refactor: バグ修正や新規機能の追加を行わないコード変更
- test: テストの追加や既存テストの修正
- chore: ビルドプロセスやドキュメント生成などのライブラリ、補助ツールの変更 (依存ライブラリの追加なども含む)
概要には変更についての簡潔な説明を記述してください。
- 内容は体言止めで記述する。「変更しました」「変更する」ではなく「変更」
- 句読点は使用しない
ここではその変更に至った動機を記述してください。なぜこの変更を行ったのかなど。変更の影響の説明として以前の動作と新たな動作の比較する内容を含めても構いません。
Footerには破壊的変更に関する情報などを記述します。またはこのコミットによってクローズ、または関連するGitHubのIssueやPRを指定したりすることも可能です。
破壊的変更: <変更に関する概要>
<空行>
<破壊的変更とそれに伴う移行についての説明>
<空行>
<空行>
#<Issue番号> を修正