Gitのコミットメッセージの書き方

Git歴浅い私が一番いい感じかな~~~って思ってるコミットメッセージの書き方をまとめてみました。
異議異論文句はすべて認めます。

原則

以下のフォーマットとします。

  • 1行目 : 変更内容の要約(タイトル、概要)
  • 2行目 : 空行
  • 3行目以降 : 変更した理由(内容、詳細)

日本語でも英語でも大丈夫ですが、リポジトリで統一してください。(英弱えんじにゃなので日本語だと嬉しいですとても)

1行目

fix : バグ修正 add : 新規(ファイル)機能追加 update : 機能修正(バグではない) change : 仕様変更 clean : 整理(リファクタリング等) disable : 無効化(コメントアウト等) remove : 削除(ファイル) upgrade : バージョンアップ revert : 変更取り消し

上記のものから適切なものを選択し、変更内容を簡潔に記述します。

# example
fix : 〇〇のバグ修正
update : 〇〇の機能追加
upgrade : 1.0.0 -> 1.1.0

3行目

変更した理由を出来るかぎり具体的に書きます。 Redmine等のチケットと連携している場合はここで紐付けを行います。

# example
database.py内connecting関数のDBの接続情報を環境変数から取得するように変更しました。

コミット単位について

主旨とはそれますが、コミットは出来る限り細かい粒度で行ってください。
「細かい」の基準は難しいと思っていますが、ひとまず、複数のバグの修正をひとつのコミットのまとめる等はよろしくないです。
最低限自分なりの哲学や一貫性があれば(説明出来れば)、いいかなーーーーーーと思っています。