Skip to content

Instantly share code, notes, and snippets.

@jan-warchol

jan-warchol/writing-good-commit-messages.md

Last active May 15, 2017 07:51
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 jan-warchol/31aaedb0dda36e05e2d5d2929d73d1b8 to your computer and use it in GitHub Desktop.
Save jan-warchol/31aaedb0dda36e05e2d5d2929d73d1b8 to your computer and use it in GitHub Desktop.
Download ZIP
Yet Another set of rules for writing good commit messages
Raw
writing-good-commit-messages.md

Important rules

  • explain why
  • explain why
  • explain why
  • help with code review

Important formatting rules

  • start with summary line (max 70 characters)
  • add more description after empty line

Nice-to-have formatting rules

  • use bullet points
  • capitalize first letter
  • add ticket number or other reference
  • use imperative mode
  • mention area affected
  • use hard wraps
  • keep git log in mind

Inspiration:

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