Skip to content

Instantly share code, notes, and snippets.

@alexkreidler

alexkreidler/conventional-commits.md

Created April 13, 2021 15:07
Show Gist options
  • Save alexkreidler/6122f2c2481be116e8eb363bf33167fa to your computer and use it in GitHub Desktop.
Save alexkreidler/6122f2c2481be116e8eb363bf33167fa to your computer and use it in GitHub Desktop.
Download ZIP
Raw
conventional-commits.md

Quick examples

  • feat: new feature
  • fix(scope): bug in scope
  • feat!: breaking change in API
  • chore(deps): update dependencies

Commit types

Type Description
build Changes that affect the build system or external dependencies (example scopes gulp, broccoli, npm)
ci Changes to CI configuration files and scripts (example scopes Travis, Circle, BrowserStack, SauceLabs)
chore Changes wich doesn't change source code or tests e.g. chnages to the build process, auxiliary tools, libraries
docs Documentation only changes
feat A new feature
fix A bug fix
perf A code change that improves performance
refactor A code change that neither fixes a bug nor adds a feature
revert Revert something
style Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
test Adding missing tests or correcting existing tests

Reminders

  • Put newline before extended commit body
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment