Skip to content

Instantly share code, notes, and snippets.

@jtanios

jtanios/conventional-commits.md

Forked from Zekfad/conventional-commits.md
Last active February 23, 2024 15:12
Show Gist options
  • Save jtanios/fc772280c06a031c4f0077aca193eee7 to your computer and use it in GitHub Desktop.
Save jtanios/fc772280c06a031c4f0077aca193eee7 to your computer and use it in GitHub Desktop.
Download ZIP
Conventional Commits Cheatsheet
Raw
conventional-commits.md

Quick examples

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

Commit types

  • feat: A new product feature
  • fix: A bug fix
  • test: Adding tests or correcting existing tests
  • refactor: Changes that neither fix a bug nor add a feature
  • chore: Changes that don't change source code or tests, e.g. changes to the build process, auxiliary tools, libraries
  • build: Changes that affect the build system or external dependencies (example scopes: npm, poetry, gradle)
  • ci: Changes to CI configuration files and scripts (example scopes: Github Actions, Travis, Jenkins)
  • docs: Documentation only changes
  • perf: A code change that improves performance
  • revert: Revert changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

More details at conventionalcommits.org

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