Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
Yet Another set of rules for writing good commit messages

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


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.