/note/tech

よいコミットメッセージ・よくないコミットメッセージ

ファイル移動を移動した事実しか書かない

(中略)

ファイルを移動したことはコミットメッセージを見なくてもdiffから分かりますが、なぜその移動をしたかが分かりません。 ので、移動した理由を残すようにするとよいです。

「指摘対応」としか書かない。

(中略)

なぜその変更をしたかが後から見たときに分かりません。 指摘があった場合はその内容を残すとよいです。

「修正した」としか書かない

繰り返しになりますが、なぜその修正をしたかがあとから分かりません。 CIやspecで確認していることをコミットメッセージに残すとよいです。