Skip to content

Instantly share code, notes, and snippets.

@andxyz
Created December 7, 2016 22:36
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save andxyz/1828bf3b0947b1be2a93fd440b1ed149 to your computer and use it in GitHub Desktop.
Save andxyz/1828bf3b0947b1be2a93fd440b1ed149 to your computer and use it in GitHub Desktop.
Writing Commit Messages

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 72 characters

  • Why, explain intention and implementation approach

  • Present tense

Atomicity

  • Break up logical changes

  • Use git add -p

  • Make whitespace changes separately

See Also

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment