Why Should I write good commit messages? ~なんでコミットメッセージが大事なん?~
私は、SVNとかGitとか関係なしに、コミットメッセージは開発していく上でとても大事だと考えています。
昨今は、ソフトウェアエンジニアだけでなく、ITインフラエンジニアもコードを書く時代なのでその重要さはもっと上がっているとすら考えています。
ただ残念なことに「コードの差分からどんな更新であったかが分かるから不要」って乱暴な人もいますが、そんな事はありません。 私は過去の経験から意識して良いコミットメセージを書くことで以下の効果があると考えています。
良いコミットメセージを書くことで得られる効果
勘違いした 変更 or 修正 を探しやすくなる
その差分が本当にやりたかった事とイコールとは限りません。その為、良いコミットメッセージを書くことで、その食い違いに気がつくことが出来ます。
また、PRでレビューする際に、レビューアがそのコミットの正しさを確認するときにも非常に役に立ちます。
未来の自分や他のメンバにとって助けになる
良いコミットメセージを書くことで、後からその更新がどんなものであったかを探しやすくなります。
半年後、1年度、そのコミット内容説明できますか?そして、未来永劫、その会社に所属していますか?
障害発生時にコードを確認する際に「1年前のあのコミットって、なんで更新したんだろう?」って頭抱えた経験無いですか?
リファクタリングする際に、ここの更新意図が曖昧でほんとに正しく更新出来ているか悩んだ経験無いですか?
コミット粒度を意識するようになる
端的にコミットメセージを書けない場合は、コミット粒度が適切でない場合が多々あります。 例えば、変更や修正が混ざっているとか、更新サイズがデカイとか。
どうやって書いたら良いのか?
その為に必要な考え方や書き方について、私が書くよりも過去の素晴らしい記事を紹介した方が効率が良いので紹介します。
コミットメッセージの書き方(考え方)
- Gitのコミットメッセージの書き方 | POSTD
- Gitコミットメッセージのプラクティスまとめ | 酒と涙とRubyとRailsと
- Gitのコミットメッセージの書き方 - Qiita
- gitとプルリクエストに関して思うことまとめ - Qiita
コミットメセージの書き方(例文)
最後に
他にも良記事があれば、是非教えて下さい!