開発でGit(Github)を利用している時、コミットメッセージは後からログを見返すときにとても大切なものだけど、
普段適当に記述しているのもあって、改めてルールを書くことにした。
コミットの粒度
コミットの粒度では、何かしら一つの作業を終えたら・・・という粒度でコミットすることにする。
具体的には
- ある範囲のUIを実装した時
- 何かしらのコードを削除した時
- バグを潰した時
など、比較的作業単位で細かくコミットするようにする・
コミットメッセージの内容
1行目 / 内容の要約
例 modify search button for product menu
2行目 / 空行
空行にする理由としては、可読性や要約と内容を分離するためにある。
3行目 / 本文
実際に何をやったのかを書く。長すぎるのもダメなのでだいたい60字ぐらいでまとめるようにしている。
例 製品メニューの箇所で、検索ボタンの位置がずれていたので修正しました。
利用する単語
- add (追加)
- Implement (実装)
- remove (削除)
- modify (修正)
- fix (バグ修正)
- move (移動)
- tmp (一時的)
まとめ
コミットメッセージ、前まで日本語で書いていたけど日本語より英語のほうが要約で伝わりやすいことに気づいた。
僕は英語が恐ろしいほど出来ないので、こういう所から慣れていきたい。