Skip to content

Instantly share code, notes, and snippets.

@yongzhihuang
Created June 10, 2015 21:28
Show Gist options
  • Save yongzhihuang/e7aa723d7d7c421af350 to your computer and use it in GitHub Desktop.
Save yongzhihuang/e7aa723d7d7c421af350 to your computer and use it in GitHub Desktop.

Commit guideline

Try to use useful categorization for each commit, currently there are these categories:

  • [FEATURE] - A new feature or small additions.
  • [STYLE] - Style related commits.
  • [BUGFIX] - A fix for a bug, try to include links to project management ticket # for reference.
  • [DOCS] - Anything relates to documentation, including adding comments, updating readmes.
  • [CONFIG] - Configuration changes.
  • [CLEANUP] - Changes that do not affect functionality such as refactoring, restructuring.
  • [WIP] - Work in progress, when working on something not completely done.
  • [SECURITY] - Anything related to server or application security.
  • [REVISIT] - Things that should be looked over again in the future.
  • [MISC] - Anything not covered by above, try to avoid this, if there's a category not clearly grouped with options above, try to add to this list.

This is useful when you want to find a commit of a particular category, you can just do git log --all --oneline | grep '\[REVISIT\]' and it would search for all commits with [REVISIT] category

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