Skip to content

Instantly share code, notes, and snippets.

@austinkettner

austinkettner/git-commit-message.md

Created August 29, 2015 23:05
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 austinkettner/a18ccdabca61f14f5ba9 to your computer and use it in GitHub Desktop.
Save austinkettner/a18ccdabca61f14f5ba9 to your computer and use it in GitHub Desktop.
Download ZIP
Git Commit Message Rules
Raw
git-commit-message.md

Git Commit Message Model

Git Commit Messages Summary

  • Capitalized, short (50 chars or less)
  • DO NOT reference Github Issues via Resolve #24, etc. This is Github specific functionality and clutters the log with non-referenceable data.
  • Always use present-tense, imperative-style writing
  • Avoid commits covering multiple changes, always commit frequently to cover specific changes
  • In any advanced changes ALWAYS include a detailed git commit message in the description/body (explaining the short summary).

Git Commit Detailed Explanation Text

  • Always toss a Github Issues reference in the detailed explanatory text, NEVER in the short summary as defined above.
  • Be clear, concise but detailed on what has changed.
  • Double check spelling and format

Additional reference sites: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html https://help.github.com/articles/closing-issues-via-commit-messages/

Commit Etiquette

  • When making changes and pushing, ensure that any issues that are resolved by your changes are immediately closed as to reflect current status.
  • Push frequently, as to keep bulk pushes to a minimum and project status consistent progressing versus batch progressing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment