Skip to content

Instantly share code, notes, and snippets.

@Zekfad

Zekfad/conventional-commits.md

Last active October 27, 2025 14:48
Show Gist options
  • Save Zekfad/f51cb06ac76e2457f11c80ed705c95a3 to your computer and use it in GitHub Desktop.
Save Zekfad/f51cb06ac76e2457f11c80ed705c95a3 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)!: 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 •
edited
Loading

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.

@B1ue-Dev
Copy link

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

@wellserrano
Copy link

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

Updating dependencies/packages is under "chore" prefix, isn't it?

@rcdailey
Copy link

I personally use build for packages/dependencies, since they're involved in the build process. But I think the point here is that we shouldn't add custom conventions beyond what is documented in the Angular repo or conventionalcommits.org.

@marcelobettini
Copy link

marcelobettini commented Nov 27, 2024 •
edited
Loading

and what about the first commit? Should it be chore?

@joe-chacko
Copy link

joe-chacko commented Dec 4, 2024 •
edited
Loading

and what about the first commit? Should it be chore?

I use "style: add empty .gitignore".
Adding an empty .gitignore file is a good first commit because it has no content and gives you a first revision (with no real content) to refer back to.

@Brian-001
Copy link

Thanks for the insight. Conventional commits are a game-changer.

@pablospe
Copy link

what do you use for git merges? "chore: merge to main"?

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