Skip to content

Instantly share code, notes, and snippets.

@Zekfad
Last active December 20, 2024 04:29
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.
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

@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

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

@joe-chacko
Copy link

joe-chacko commented Dec 4, 2024

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 essentially nothing in it to refer back to.

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