概要
レビュアーは得てして忙しいことが多いと思うので、読んでもらえるような優しいコミットコメントをつけようというお話
結論
1コミットで1つの対応「のみ」を行う
シンプルにこれだけ。
Simple is best.
利点と欠点
利点
レビュアーの負荷軽減。
大量のコミット、大量の変更、かつコメントと修正内容の不一致を起こしていると、レビュアーが疲弊してしまう。
コミット単位の意味が単純かつ明確であると、背景を読む必要がなくなり負荷が減る。
また、コミットが複数ある場合でも、「このコミットまで確認した」という区切りがつけやすい。
複数の意図が混ざったコミットコメントだと、作業中断から再開したときに、スイッチングコストがかかってしまう。
欠点
レビュイーの手間が少し増える。
ただし、これを意識できると、忙しいレビュアーから後回しにされるようなことは減ると思う。
具体例
NG
・コミットコメントで記載されている以外のことしている
「バグ修正のコミットコメントに対して、コード差分としてはリファクタリングをも実施している」場合などが該当。
意図が異なるものを混ぜてコミットしている。
先に触れたとおり。見る側が大変。
・曖昧なコミットコメント
「一時コミット」のようなもの。意図がわからず確認する手間が出てしまう。
一時利用には git stash を使ったり、コミットメッセージを修正して明確にしよう。
OK
・hoge機能の新規追加と、それに伴うテスト修正。
・バグ番号{num} の修正対応。それに伴うテスト修正。
・パフォーマンスチューニング。DBのconnection数を、{num}から{num}に変更。
・リファクタリング
スペシャルサンクス
監修 @yk-azarashi