コミットメッセージの作法

More than 5 years have passed since last update.

gitプロジェクトのガイドラインを参考にまとめました。この作法は英語で書くことが前提となっています。


1. コミットメッセージの1行目は短い説明文(50文字以内)


  • モジュールについての修正の場合、モジュール名: ではじめる

  • 説明文は小文字ではじめる

  • 説明文のピリオド(句点)を省く


2. 2行目は空行にする

そうすることで、例えばコミットした内容を E-Mail に変更するツールにて、 Subjectに最初の行を使用し、残りの行を本文にすることができる。


3. 本文には意味ある内容を含める


  • 問題点: 修正した問題点について説明する

  • 妥当性: 行った修正について、「なぜその方法がより良いのか」を説明する

  • 代替案: もし、他の修正方法を検討したのなら、それらについて説明する


4. 変更は命令形で表現する

まるであなたがコードベースに変更を命令じているかのように書く。


  • [bad] "This patch makes xyzzy do frotz"

  • [bad] "I changed xyzzy to do frotz"

  • [ok] "make xyzzy do frotz"


5. 書いた内容が他の資料なしに理解できるものか確認する

メーリングリストのURLを指し示す代わりに、関連する点について要約する。


コミットメッセージの形式


モジュール名: 簡潔な説明文

どのような問題があり、どのような修正を行ったか...

その修正はなぜ他の方法より良いか...

他に検討した修正方法はどんなものか...(あれば)