Skip to content

Instantly share code, notes, and snippets.

@sh78

sh78/git commit checklist.md

Created April 18, 2018 02:17
Show Gist options
  • Save sh78/6964277332c13338656656786aff1a88 to your computer and use it in GitHub Desktop.
Save sh78/6964277332c13338656656786aff1a88 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
git commit checklist.md
  • only relevant files/changes are staged
  • imperative tone is used without past tense
  • type is referenced by the first word: -- feat: a new feature -- fix: a bug fix -- docs: changes to documentation -- style: formatting, missing semi colons, etc; no code change -- refactor: refactoring production code -- test: adding tests, refactoring test; no production code change -- chore: updating build tasks, package manager configs, etc; no production code change
  • subject <= 50 characters wide
  • blank line between the title and the body
  • body <= 72 characters wide -- Explain the problem that this commit is solving. -- Are there side effects or other unintuitive consequences of this change?
  • issue tracker IDs referenced in the footer if applicable
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment