複数の場所でgitを使う機会が増えてきたのでおさらい.
コミットメッセージで守るべきルール
How to Write a Git Commit Messageの "The seven rules of a great Git commit message" より.
- コミットのタイトルの次の行は空白行にする
- コミットのタイトルを50字まで
- コミットのタイトルの頭文字は大文字に
- コミットのタイトルの文末にピリオドは不要
- コミットのタイトルは命令形(imperative)
- コミットの概要(タイトル以下の文章)は1行72字まで
- ただしタイトルだけで十分伝わる(typoなど)場合はタイトルのみで良い
- コミットの概要(タイトル以下の文章)で何を変えたかとなぜそれをしたかを説明する
コミットのタイトル
基本50字以内で記述、最大69字. 命令形に統一し、過去形などの混在を避ける.
If applied, this commit will ... (引用元: How to Write a Git Commit Message)
の ...
にちょうど入るようなコミットのタイトルが良い.
アトミックコミット
コミットの内容を約50字でまとめられ無い場合、コミットに含まれる変更が多すぎる可能性を考えてみる.
コミットメッセージ例
- Add 機能追加・ファイル追加
- Fix バグなどの修正
- Update サードパーティのライブラリ・テスト用のファイルなどを更新
- Improve 改善(高速化、コード整理など)
- Remove ファイル・コードを除去する
- Rename ファイル名を変更
- Move ファイルを移動する
- Don't 何らかの機能を使用しないように変更
- Use 何らかの機能やサードパーティなどを使用するように変更、Use XXX instead of YYYなど.
- Change 変更(ログの内容変更、など)
他のコミットメッセージ例は以下のページを参照.
[転載] gitにおけるコミットログ/メッセージ例文集100 · GitHub
git bisect
最新版にバグが含まれていた場合、どのコミットにバグが含まれているか・重要でないコミットが含まれるかを探索.
アトミックコミットを意識しつつ、コミットの内容とメッセージを整えておけばどの時点でバグが含まれたのかも調べやすい.