[Git] コミットコメントの書き方

一般的なGitのコミットコメントの書き方をまとめてみました。

Gitコメントの書き方

Gitコメントは以下のような３行からなるコメントとすると見やすいです。
（３つめは複数行の可能性もあるため３行とは限りません。）

以下にそれぞれの行について解説します。

★１行目：種別と対応内容

種別と対応内容を記載します。
種別は対応内容により以下のいずれかの種別を[]付きで指定します。
対応内容は、ひと目で修正内容が分かるように簡潔に１行で書きます。

種別があることで、ひと目でどのような対応内容かが分かります。

（種別）

• add 新規追加
• update 修正（仕様変更、機能追加等のバグ修正以外）
• fix 修正（バグ修正）
• remove 削除

（書き方例）

[update] 消費税10%対応 [fix] 合計値がおかしい不具合修正

★２行目：空行

見出しと修正詳細を分けて見やすくするために１行空けます

★３行目～：対応内容の詳細

コミットで対応した内容の詳細を記載します。
どういう経緯で対応したのかや、修正した箇所の説明など後々他の人が見返した時でも理解できるように記載します。

（書き方例）

消費税10%対応による対応で以下の修正を行いました。 ・税区分の追加 ・追加した税区分を考慮したIF文に修正

対応内容の詳細は複数行になっても構いません。

備考

• このルールの書き方でしたら、大体どこのプロジェクトへ行っても通用すると思います。
• 種別の種類に関しては、プロジェクトごとに違いがあったりするので現場のルールを確認してみてください。