Commit Messages

Posted 2015-06-26 04:53 PM GMT

Much has been written and said about commit messages. My intention with this post is to write a short and clear summary of what makes a good commit message.

  1. A commit message should be short and clear. If the description needs to be long and confusing, the commit is probably too large.
  2. A commit message should be in the present (not past) tense. Describe what the commit is doing, not the work you did. A past-tense commit message is also arrogant, because it implies that you think your code is so certain to be merged that you can describe it as if it has already happened.
  3. A commit message can be funny, given the humor does not make unclear the meaning in the message. The robots are not being programmed by robots; let your personality show.