Commits

Git Commit Message Convention

This is adapted from Angular's commit convention.

Messages must be matched by the following regex:

/^(revert: )?(build|chore|ci|deps|docs|feat|fix|perf|refactor|release|test|types|wip|workflow|workspace)(\(.+\))?: .{1,50}/;

Explanation

On/Off	Message	Description
	build	Changes that affect the build system or external dependencies
	chore	Chore development
	ci	Changes to our CI configuration files and scripts
	deps	Dependencies
	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
	release	Start or prepare for a new release
	test	Adding missing tests or correcting existing tests
	types	Types
	wip	Work in progress
	workflow	Workflow
	workspace	Workspace changes

Examples

Appears under "Features" header, dev subheader:

feat(dev): add 'comments' option

Appears under "Bug Fixes" header, dev subheader, with a link to issue #28:

fix(dev): fix dev error

close #12

Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:

perf(build): remove 'foo' option

BREAKING CHANGE: The 'foo' option has been removed.

The following commit and commit 667ecc1 do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.

revert: feat(compiler): add 'comments' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Revert

If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit. In the body, it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

If the prefix is feat, fix or perf, it will appear in the changelog. However, if there is any breaking change, the commit will always appear in the changelog. Other prefixes are up to your discretion. Suggested prefixes are docs, chore, style, refactor, and test for non-changelog related tasks.

Scope

The scope could be anything specifying the place of the commit change. For example dev, build, workflow, cli etc...

Subject

The subject contains a succinct description of the change:

• use the imperative, present tense: "change" not "changed" nor "changes"
• don't capitalize the first letter
• no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.