gitのコミットメッセージの書き方
最近ようやくgitをまともに使うようになってきました。
コミットメッセージの書き方がよくわかってなかったのでまとめます。
基本的なコミットメッセージのスタイル
- 英語で記述すること!!
- ピリオドなし
- 現在時制
- 文頭の単語は大文字から開始
基本フォーマット
- 一行目:変更内容の要約(タイトルと概要)
- 二行目:空白
- 三行目:変更の理由、詳細
大事な一行目
三行目は適当に英作文すれば良いのでやはり大事なのは一行目。コミットの種類と要約が人目でわかるように記述します。
フォーマット
[コミット種別]+"要約"
ex). [fix] Fix some Bugs in hogehog method
コミット種別
- fix:バグ修正
- hotfix:クリティカルなバグ修正
- add:新規(ファイル)機能追加
- update:機能修正(バグではない)
- change:仕様変更
- clean:整理(リファクタリング等)
- disable:無効化(コメントアウト等)
- remove:削除(ファイル)
- upgrade:バージョンアップ
- revert:変更取り消し
普通に書いていると hotfix とか revert とか書かないので覚えとこう