Skip to content

Instantly share code, notes, and snippets.

@volks73
Last active October 19, 2019 14:00
Show Gist options
  • Save volks73/fb7e14afcf8f3a7335dfc429f98557f0 to your computer and use it in GitHub Desktop.
Save volks73/fb7e14afcf8f3a7335dfc429f98557f0 to your computer and use it in GitHub Desktop.
Convention for writing git commit messages
  • Add = Create a capability e.g. feature, test, dependency.
  • Cut = Remove a capability e.g. feature, test, dependency.
  • Fix = Fix an issue e.g. bug, typo, accident, misstatement.
  • Bump = Increase the version of something e.g. dependency.
  • Make = Change the build process, or tooling, or infra.
  • Start = Begin doing something; e.g. create a feature flag.
  • Stop = End doing something; e.g. remove a feature flag.
  • Refactor = A code change that MUST be just a refactoring.
  • Reformat = Refactor of formatting, e.g. omit whitespace.
  • Optimize = Refactor of performance, e.g. speed up code.
  • Document = Refactor of documentation, e.g. help files.

Taken from a Hacker News post by navinsylvester on 2019-10-19.

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