Skip to content

Instantly share code, notes, and snippets.

@maiastone

maiastone/proper-commits.md

Created October 31, 2016 15:29
Show Gist options
  • Save maiastone/e34f29b382aee96e3913209d697c22b9 to your computer and use it in GitHub Desktop.
Save maiastone/e34f29b382aee96e3913209d697c22b9 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
proper-commits.md

What are some rules of thumb for proper commit messages?

  • a commit message shows whether a developer is a good collaborator.
  • concise and consistent
  • a maintainer has few tools more powerful than his project's log

Seven Rules

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line - The imperative mood is a verb form which makes a command or a request.
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

tpope
google chrome lighthouse

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