From 227a3c7c6bc880ca10d8c396ec5223518a0584eb Mon Sep 17 00:00:00 2001 From: cxm Date: Sun, 27 Mar 2022 23:55:18 +0800 Subject: [PATCH] Feat: commit msg & ci --- .github/COMMIT_CONVENTION.md | 93 ++++++++++++++++++++++++++++++++ .github/workflows/commitlint.yml | 33 ++++++++++++ 2 files changed, 126 insertions(+) create mode 100644 .github/COMMIT_CONVENTION.md create mode 100644 .github/workflows/commitlint.yml diff --git a/.github/COMMIT_CONVENTION.md b/.github/COMMIT_CONVENTION.md new file mode 100644 index 0000000000..9a9a211150 --- /dev/null +++ b/.github/COMMIT_CONVENTION.md @@ -0,0 +1,93 @@ +## 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|ci|chore|types)(\(.+\))?: .{1,50}/ +``` + +#### Examples + +Appears under "Features" header, `compiler` subheader: + +``` +feat(compiler): add 'comments' option +``` + +Appears under "Bug Fixes" header, `bananapi` subheader, with a link to issue #28: + +``` +fix(bananapi): enable CONFIG_NETFILTER_XT_TARGET_LOG + +close #28 +``` + +Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation: + +``` +perf(core): 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(compiler): 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**: + +``` +(): + + + +