diff --git a/.github/COMMIT_CONVENTIONS.md b/.github/COMMIT_CONVENTIONS.md new file mode 100644 index 000000000..db48dad77 --- /dev/null +++ b/.github/COMMIT_CONVENTIONS.md @@ -0,0 +1,91 @@ +## Git Commit Message Convention + +> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular). + +#### TL;DR: + +Messages must be matched by the following regex: + +```js +;/^(revert: )?(feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore|types)(\(.+\))?: .{1,50}/ +``` + +#### Examples + +Appears under "Features" header, `Server Utils` subheader: + +``` +feat(server-utils): add 'props' option +``` + +Appears under "Bug Fixes" header, `Test Utils` subheader, with a link to issue #28: + +``` +fix(test-utils): handle events on blur + +close #28 +``` + +Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation: + +``` +perf(test-utils): improve vdom diffing by removing '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(server-utils): add 'comments' option + +This reverts commit 667ecc1654a317a13331b17617d973392f415f02. +``` + +### Full Message Format + +A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**: + +``` +(): + + + +