😼
Gitのコミットメッセージの良い書き方
一般的に良いとされるコミットメッセージの書き方をポイントでChatGPTのo1の力を借りてまとめてみます。
コミットメッセージの一般的な書き方を学んだうえで、チームでルールを決めて統一するととても読みやすくなって良いでしょう。
コミットメッセージの書き方として、以下のポイントを押さえておくとよいとされています。
1. 大原則として「何が」「なぜ」おこなわれたのかを説明する
コミットメッセージは「この変更で 何が 行われたのか」「 なぜ その変更を行ったのか」を伝えるためのものです。
つまり、 What と Why がわかるように書くのが大事です。
レビュアや将来の自分を含めて、メッセージを読んだ人が変更の意図をすぐに理解できるように意識しましょう。
2. 件名と本文を分ける
コミットメッセージには大きく次のような構成が推奨されています。
<件名 (最大 50 文字程度)>
<空行>
<本文 (詳細説明)>
（例）
Add: ログインページを追加した
要件にあるGoogleアカウントでのログインおよびパスワードでのログインを受け付けるようにした
-
件名
- 何をおこなったのか書く。
- できるだけ 50 文字以内にまとめる。
- 文末にピリオド（.）や句読点など（。）を付けない。
-
本文
- 1 行につき 72 文字以内を目安に改行する。
- なぜその変更が必要なのか、具体的な背景や変更内容を簡潔に説明する。
- どう実装したかよりも「なぜその変更をしたか」に重点を置く。
- テスト方法や影響範囲なども書くと、将来参照したときに便利。
3. prefixを付ける
addやremoveなどを最初につけると何をしたのかについてすぐに分かるので付けます。
（例）
add: ~~を追加した
remove: ~~を削除した
fix: ~~を修正した
refactor: ~~部分を整理した
chore: ~~をした
※ chore は、ちょっとした変更を加えたときのもの。雑務的な意味。
4. コミットの粒度を意識する
- 一度に大量の変更を行うのではなく、関連する変更を1つのコミットにまとめるかたちでコミットを作成する。
- それぞれのコミットが「ひとつの論理的変更」に対応していると、コミットメッセージも書きやすく、後から検索・巻き戻し・レビューがしやすい。
まとめ
- 「何を」「なぜ」変えたのか を簡潔にまとめる。
- 自分やチームの 運用目的や文化に合わせたフォーマット を決め、継続的に守ることが大切。
上記を意識してコミットメッセージを書くことで、開発者同士のコミュニケーションがスムーズになり、プロジェクト管理や保守が格段にしやすくなります。
Discussion