diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..8ddc789 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @BlessInSoftware/ZeroDay diff --git a/.github/COMMIT_CONVENTION.md b/.github/COMMIT_CONVENTION.md new file mode 100644 index 0000000..0860fa9 --- /dev/null +++ b/.github/COMMIT_CONVENTION.md @@ -0,0 +1,93 @@ +# Git conventional commit messages + +> Note +> This is adapted from [Discord.js commit convention](https://github.com/discordjs/discord.js/blob/main/.github/COMMIT_CONVENTION.md) and [Conventional commits](https://www.conventionalcommits.org). + +## TL;DR + +Messages must be matched by the following regex: + +```js +/^(revert: )?(feat(\(.+\))?:|fix(\(.+\))?:|docs(\(.+\))?:|style(\(.+\))?:|refactor(\(.+\))?:|perf(\(.+\))?:|test(\(.+\))?:|build(\(.+\))?:|ci(\(.+\))?:|chore(\(.+\))?:) .{1,72}/; +``` + +### Examples + +Appears under "features" header, `scope` subheader: + +```text +feat(scope): add 'tag' method +``` + +Appears under "fixes" header, `scope` subheader, with a link to issue #1: + +```text +fix(scope): handle events correctly + +close #1 +``` + +Appears under "performance" header, and under "Breaking Changes" with the breaking change explanation: + +```text +perf(core)!: improve patching by removing 'bar' option + +BREAKING CHANGE: The 'bar' option has been removed. +``` + +The following commit and commit `410fbbc` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header. + +```text +revert: feat(Managers): add Managers + +This reverts commit 410fbbc5c4d0072b9bb97a466f56b07c90b926be. +``` + +### Full Message Format + +A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**: + +```text +(): + + + +