コミットメッセージの書き方
- 英語で書く
- 命令形 (imperative mood) / 原形不定詞 (bare infinitive) で書く
- Imperative mood:
- “spoken or written as if giving a command or instruction”
- 命令形
- 命令や指示を与えるかのような形式
参考：
How to Write a Git Commit Message | Chris Beams
概要
- コミットメッセージの1行目にはピリオドを付けない (件名に相当)
- バックアップファイルは含めない (.gitignore で不要ファイルを含めない設定をする)
- コメントアウトした不要コード (変更前のコード) をコミットしない
参考：
git commit するまえに考えるべき10のこと | Act as Professional
Git でより良いコミットメッセージを書く方法 | yu8mada
誰にとってもわかりやすい Git のコミットメッセージを考える | Tips Note by TAM
英文
- Add …
- Change … to …
- Remove … (from …)
- Move … (from …) to …
- Rename …
- Fix …
- Update …
- Convert … to …
- Support …
参考：
git におけるコミットログ/メッセージ例文集100 – GitHub Gist
GitHub で使われている実用英語コメント集 – Qiita
プレフィックス
AngularJS 式
- feat: A new feature 新しい機能
- fix: A bug fix バグの修正
- docs: Documentation only changes ドキュメントの変更
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) コーディングスタイルの変更
- refactor: A code change that neither fixes a bug nor adds a feature リファクタリング
- perf: A code change that improves performance パフォーマンスの改善
- test: Adding missing or correcting existing tests テストの追加・修正
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation 雑多な変更 (ツールの追加・修正、雑用的な修正など)
ドキュメント：
Type – angular.js/DEVELOPERS.md – angular/angular.js – GitHub
参考：
コミットメッセージに 「プレフィックス」 をつけるだけで、開発効率が上がった話 – Qiita
コミットメッセージのプレフィックスを決めておく – Qiita
コミットメッセージにプレフィックスをつけよう！ – Qiita
プレフィックス集／コミットメッセージの先頭に付ける単語リスト – Qiita
僕のコミットメッセージのプレフィックスメモ | ryota2357
コミットで使用するプレフィックス (otaon) – GitHub Gist
アンチパターン
参考：
コミットメッセージアンチパターン／コメント対応 | koic の日記
イシュー番号 (Issue ID)
#NN： 特定のイシューへのリンクが張られるclose #NN/fix #NN/resolve #NN： イシューが自動でクローズされる
参考：
GitHub の issue と commit を紐付ける – Qiita
GitHub で commit に issue を紐付ける | エンジニアもどきの技術メモ
まとめ
Conventional Commits
公式サイト：
Conventional Commits [Official]
リポジトリ：