diff --git a/.github/COMMIT_CONVENTION.md b/.github/COMMIT_CONVENTION.md new file mode 100644 index 0000000..691df85 --- /dev/null +++ b/.github/COMMIT_CONVENTION.md @@ -0,0 +1,87 @@ +## 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|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,72}/; +``` + +#### Examples + +Appears under "Features" header, `interactionCreate` subheader: + +``` +feat(interactionCreate): add 'tag' method +``` + +Appears under "Bug Fixes" header, `guildCreate` subheader, with a link to issue #28: + +``` +fix(guildCreate): handle events correctly +close #28 +``` + +Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation: + +``` +perf(core): improve patching by removing 'bar' option +BREAKING CHANGE: The 'bar' 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(Ping): add client ping +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**: + +``` +(): + + + +