わかりやすいコミットメッセージ

コミットメッセージの役割

何をなぜ変更したのかを記述する

コミットメッセージの目的

• 過去の状態に戻したい時にいつのデータに戻ればよいかわかりやすくすることで、作業の効率化を図る
• 自分以外の人が履歴を確認した時にわかりやすくすることで、作業の効率化を図る

書くべきこと

コミットメッセージには「何を」と「なぜ」を書くのが望ましいです。
その理由はコミットを5W1Hに当てはめてみると明らかになります。

• When(いつ)　　：いつ変更を加えたのかはタイムスタンプを見れば分かる
• Where(どこで)　：どこを変更したかはファイル名とディレクトリで分かる
• Who(誰が)　　　：誰が変更を加えたのかは 作者(author)を見れば分かる
• What(何を)　　　：何を変更したかはファイル名だけでは瞬時に判断しずらい
• Why(なぜ)　　　：コミットメッセージに書かないとわからない
• How(どのように)：どうやって変更を加えたのかは実装を読めば分かる

つまり、コミットメッセージには「What」と「Why」を書くべきで、変更の意図を伝えることが大事だということです。
加えて、プレフィックスをつけると、どのような変更があったのかも分かりやすくなります。

プレフィックス例

プレフィックス	説明
Add	機能の追加やファイル追加
Fix	バグ修正
Update	バグではない機能修正
Change	仕様変更による機能修正
Disable	無効化 (コメントアウト等)
Delete	機能削除やファイルの削除
Revert	コミットの巻き戻し
Marge	統合
Move	リソースの移動
Rename	ファイル名の変更

ちなみに絵文字を記述することもできるようです。。
絵文字への意味を持たせておけば、パッと見で判断することも可能となります。

最後に

現場によってルールが決まっている場合もあるため、最初に確認するとよいと思います。