Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Conventional Commits Cheatsheet

Quick examples

  • feat: new feature
  • fix(scope): bug in scope
  • feat!: breaking change / feat(scope)!: rework 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 which doesn't change source code or tests e.g. changes 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

@Mohammad-Alavi
Copy link

Mohammad-Alavi commented Jan 15, 2022

There is a typo.
chore: ..... chnages ....
should be
chore: ..... changes ....

Thanks for this btw 😃

@Zekfad
Copy link
Author

Zekfad commented Jan 15, 2022

Thanks, now fixed!

@megatank58
Copy link

There is a typo. It should be chore: Changes which ...
instead of chore: Changes wich

@Zekfad
Copy link
Author

Zekfad commented Jan 29, 2022

Thanks, now fixed!

@rcdailey
Copy link

Suggestions:

  1. Add a quick & convenient link to the official guide: https://www.conventionalcommits.org/en/v1.0.0/
  2. Under Quick Examples, add an additional example for breaking changes (or modify the existing one) to show how the exclamation point also goes after the scope, if present. You show feat!: but maybe also show feat(scope)!:.

@Zekfad
Copy link
Author

Zekfad commented May 24, 2022

Added your suggestions.

@Jimmy-Blue
Copy link

Suggestions:
Adding vendor type, which is used for updating dependencies/packages.

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