Good Git Commit Messages

December 8, 2013

A question that came up at almost each of the GitHub talks was,”How do I write a good commit message?” 先月のGitHubトークで結構頻繁に聞かれていた質問が「良いコミットメッセージのルールは何?」

The answer to this was short and simple・答えは結構シンプルだった:

  1. Write the why not the what 何をしたかではなく、何故を書く。

It’s possible to discern what was done by looking at the code that was added. What’s more important is to explain the why. コードを見れば何はわかるから、重要なのは何故。

  1. Write commit messages in the present tense and not past tense. コミットメッセージは現在形で書く、過去形は使わない。

An additional comment to this was, whether it’s present or past tense, choose one and stick to it. 追加のコメントとして言われていたのが、現在形だろうが過去形だろうが、どちらかを選んでそれだけを使う。

Another point that was brought up was looking at a commit log should be like a chat with the person that wrote the commit messages. もうひとつ言われた事はcommit logを見ているときはcommit messagesを書いた人とのチャットであるべき。

Discussion, links, and tweets

Good Morning!