忙しいレビュアーにも読んでもらえるような優しいコミットコメントをつけよう - Qiita

概要 レビュアーは得てして忙しいことが多いと思うので、読んでもらえるような優しいコミットコメントをつけようというお話 結論 1コミットで1つの対応「のみ」を行う シンプルにこれだけ。 Simple is best. 利点と欠点 利点 レビュアーの負荷軽減。 大量のコミット、大量の変更、かつコメントと修正内容の不一致を起こしていると、レビュアーが疲弊してしまう。 コミット単位の意味が単純かつ明確であると、背景を読む必要がなくなり負荷が減る。 また、コミットが複数ある場合でも、「このコミットまで確認した」という区切りがつけやすい。 複数の意図が混ざったコミットコメントだと、作業中断から再開したときに、スイッチングコストがかかってしまう。 欠点 レビュイーの手間が少し増える。 ただし、これを意識できると、忙しいレビュアーから後回しにされるようなことは減ると思う。 具体例 NG ・コミットコメント