Gitのコミットメッセージをうまく書けない人たちへ
わたしです。
Gitのコミットメッセージを書くときに、修正内容を簡潔にまとめられない。まとめてみても、「いや、それプログラム見たらわかることだから」という書き方しかできない。ということに悩んでいました。
そもそもGitのコミットメッセージのルールってあるのかな？と調べてみると、とても参考になる記事を見つけました。
こちらの記事は英語でコミットメッセージを書くときの例なので、日本語で書くことを考えると当てはまらないルールもありますが、コミットメッセージに書かなければいけない内容やフォーマットは英語も日本語も変わりません。
コミットメッセージの書き方
コミットメッセージのフォーマットは以下。
1: タイトル 2: (空行) 3: 本文
タイトル
タイトルは簡潔にまとめること。
「なぜ」この変更を行ったのかを説明する。タイトルで説明しきれない場合は、本文で説明する。
空行
以下の本文を書くときには、タイトル下に1行の空行を入れること。
本文
変更内容について、「なに」を「なぜ」その方法で解決したのかを説明すること。
「どのように」解決したかはプログラムを読めばわかるので、本文で説明する必要はない。
関連するチケット等がある場合は、ここにチケット番号などを記載しておく。
まとめ
このコードは何のためにあるのかな？とgit blameでコミットログを漁っていると、「○○の処理を追加した」「○○のチェックを行った」など、そのコードを書くことに至った経緯を説明してくれるコミットメッセージってあんまり見かけない。結局このコードっているの？(´・ω・｀)と困惑することが多いです。
将来自分のコードを見る、触る人たちのためにも、なんとなくコミットメッセージを書くのではなく、親切なコミットメッセージを書くことを心がけていきたいと思います。
