コミットメッセージの話

本記事はマイネット Advent Calender 11日目の記事です。 本日はito-kenがお送りします。

はじめに

ゼロからずっとプロダクトに関わっている人でない場合、

メッセージもコーディング規約と同じノリで

「既に決まっているフォーマットに乗っかって書く」事が多いと思います。

フォーマットが決まっておらずカオスになっていたり、

ツールとの依存関係上やPJ発足からの慣例、もしくはリーダーの単純な趣味嗜好で

「必ず○行で書け」という状態もありえます。

まだ良い方

  • 「○○(人名)本日作業分」
  • 「○○終わりませんでした。明日相談させてください」

つらい

  • 「update」
  • 「次の人後よろ」
  • 「メモ」

こんな殺意湧き上がるメッセージの犠牲者も多いのではないでしょうか。 このような犠牲者を生み出さない為に、我々に出来る事は何でしょうか。

規約や約束事が決まる(or 見直す)タイミング

開発が運用と並行してしまうと、何を変えるにもそれなりの労力が要ります。 最初が肝心ですが、ツールを変える時などはチャンスでしょう。

多いタイプ

  • 1行目   要約(必要な場合チケット番号+α)
  • 2行目   空欄
  • 3行目以降 コミットメッセージ本文

gitの標準ですね。 これを基準にメッセージを書いている方が多いかと思われます。

メッセージ規約ドキュメント作ったよ!読む?

皆さん一度だけ読んでくれます。その後、誰も読まないと思います。 「誰でも一発で把握できる」位の分量にするのが良いかと。

  • チケット番号の有無
  • 簡単なフォーマット
  • 対象機能や対象ファイルの明記の有無
  • 見ただけでだいたい把握できる例文がいくつかあると尚良し
  • 外国人メンバーが居る場合は英語での例文もあると幸せ

といったところでしょうか。

おわりに

炎上中や、開発者が少数の場合はメッセージが荒れがちですが

チームで余計な手戻りや連携ミスなどを回避する為にも

自分自身も気をつけつつ、整備されているかは気をつけたい所ですね。