Skip to content

Instantly share code, notes, and snippets.

@patrickjohnstevens

patrickjohnstevens/conventional-commits.md

Forked from Zekfad/conventional-commits.md
Created December 15, 2021 19:41
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save patrickjohnstevens/c06c528a05a3c933a8b39e689aa16fec to your computer and use it in GitHub Desktop.
Save patrickjohnstevens/c06c528a05a3c933a8b39e689aa16fec 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 in API
  • chore(deps): update dependencies

Commit types

  • 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