gistfile1.mkd

Writing Commit Messages

One line summary (< 50c)

Longer description (wrap at 72c)

Summary

• Less than 50 characters

• What was changed

• Imperative present tense (fix, add, change)

    Fix calendar timezone bug
    Add tests for Account#create
    Change file upload limit
  

• No period

Description

• Wrap at 73 characters

• Why, explain intention and implementation approach

• Present tense

Atomicity

• Break up logical changes

• Use git add -p

• Make whitespace changes separately

See Also

• http://twitter.com/rtomayko/status/21628259289
• http://progit.org/book/ch5-2.html#commit_guidelines
• http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
• http://who-t.blogspot.com/2009/12/on-commit-messages.html