Skip to content

Instantly share code, notes, and snippets.

@hilarylewis92

hilarylewis92/gitCommitResearch.md

Last active October 31, 2016 15:55
Show Gist options
  • Save hilarylewis92/72951366f6c095ddd58960763b8ede1c to your computer and use it in GitHub Desktop.
Save hilarylewis92/72951366f6c095ddd58960763b8ede1c to your computer and use it in GitHub Desktop.
Download ZIP
Raw
gitCommitResearch.md

###Some rules of thumb for proper commit messages:

  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 If applied, this commit will fixed bug with Y vs. If applied, this commit will refactor subsystem X for readability

  6. Wrap the body at 72 characters: add line to ~/.vimrc autocmd Filetype gitcommit setlocal spell textwidth=72

  7. Use the body to explain what and why vs. how

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