Skip to content

Instantly share code, notes, and snippets.

@drew-t

drew-t/commit_messages.md

Created April 14, 2016 15:43
Show Gist options
  • Save drew-t/4bab450f77b1fc1617e1a41f881bebdf to your computer and use it in GitHub Desktop.
Save drew-t/4bab450f77b1fc1617e1a41f881bebdf to your computer and use it in GitHub Desktop.
Download ZIP
Best Practices for Git Commits
Raw
commit_messages.md
  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Use the imperative mood in the subject line
    • If applied, this commit will your subject line here
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how
    • Why is the change necessary?
    • High level how?
    • What side effects
  • Link to issue/storycard instead of just putting issue number
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment