Writing good commit messages

(origin: erlang/otp/wiki/Writing-good-commit-messages/f323f71, Translated at 2013-07-25 20:15 +09:00 JST)

しっかりしたコミットメッセージを書きましょう (Writing-good-commit-messages)

優れたコミットメッセージは少なくとも３つの重要な利点を提供します:

• レビュープロセスをスピードアップさせます

• より良いリリースノートを書く手助けになります

• Erlang/OTP の将来のメンテナ(それはあなたかもしれないですよ!)を助けて, なぜコードに特定の変更が行われたのか, またなぜ特定の機能が追加されたのかの調査において, 5年後の未来に説明してくれます

コミットメッセージの構造は以下のようになります:

Summarize clearly in one line what the commit is about

Describe the problem the commit solves or the use
case for a new feature. Justify why you chose
the particular solution.

行うべき (DO)

• 要約行及び行ったことをあたかも誰かに命令しているかのように命令形で記述します: “fix”, “add”, “change” と記述する, “fixed”, “added”, “changed” ではなく.

• 2行目は空行にしておきます

• コミットメッセージは改行する (gitk で水平スクロールなしに読むことができるように).

行なってはならない (DON’T)

• 要約行の末尾にピリオドをうってはいけません.

Tips

• もしコミットが何を行なっているのかを要約するのが難しいのなら, それは複数の論理的な変更やバグ修正を含んでいて, git add -p を使っていくつかのコミットに分割したほうがよいからでしょう.

参照 (References)

以下のブログ投稿はコミットメッセージについて良い議論となっています:

On commit messages