Conventional Commits

©Cid Miranda — https://www.flickr.com/photos/cidska/

A specification for adding human and machine readable meaning to commit messages

The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.

The commit message should be structured as follows:

[optional :emoji:] <type>[optional scope]: <description>

[optional body]

[optional footer(s)]

The commit contains the following structural elements, to communicate intent to the consumers of your library:

1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
4. types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
5. footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.

Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.

Why Use Conventional Commits

• Automatically generating CHANGELOGs.
• Automatically determining a semantic version bump (based on the types of commits landed).
• Communicating the nature of changes to teammates, the public, and other stakeholders.
• Triggering build and publish processes.
• Making it easier for people to contribute to your projects, by allowing them to explore a more structured commit history.

Emojis

Initial commit 🎉 :tada:

Tag version 🔖 :bookmark:

New resource ✨ :sparkles:

List of ideas (tasks) 🔜 :soon:

Bugfix 🐛 :bug:

Documentation 📚 :books:

Tests 🧪 :test_tube:

Add test ✅ :white_check_mark:

Passing Test ✔️ :heavy_check_mark:

Accessibility ♿ :wheelchair:

Text 📝 :pencil:

Package.json 📦 :package:

In progress 🚧 :construction:

Configuration files 🔧 :wrench:

Removing a Dependency ➖ :heavy_minus_sign:

Adding a Dependency ➕ :heavy_plus_sign:

Reverting changes 💥 :boom:

Code review changes 👌 :ok_hand:

Refactoring ♻️ :recycle:

Move/Rename 🚚 :truck: