勉強：gitのコミットコメントについて
短くまとめると.......
- なぜ変更したのか？（Why）
- 何を変更したのか？（What）
- コメントに一貫性があって完結
- 変更前と変更後の機能の違い
- なぜその方法で修正したのか
が大事。だと私が思いました。うん。
最近指摘を受けた内容をまとめました。
プログラミング言語で、ネーミングやフォーマットはルールに従って記述していると思うのですがコミットコメントにおいてもルールを今後決めておくとスムーズ。
７つのルールについて
を参考にさせていただきました。
具体的には
-
タイトルの後は１行あけて本文を書く
-
タイトルを５０文字以内におさめる
-
タイトルの文頭を大文字にする
-
タイトルの文末にピリオドをつけない
-
タイトルは命令形で記述する
-
本文は１行あたり７２文字以内におさめる
-
本文ではどのようにではなく何をとなぜを説明する
だそうです。
上記のリンクに詳しい内容が書いてあります。
コミットメッセージ奥が深いです。
指摘されて問題意識に気づいた私ですが、慣れるまではコミットのコメントを書くときにルールに則って、上記がクリアできているか確認するとよいと思いました。
