From 0fb54ae0897afc3cedd045589341fbacebccd333 Mon Sep 17 00:00:00 2001 From: Kia King Ishii Date: Sun, 19 Apr 2020 19:20:47 +0900 Subject: [PATCH] build: add conventional changelog support (#1707) * build: add conventional changelog support * chore: fix changelog script typos --- .github/commit-convention.md | 91 +++++ .github/contributing.md | 35 ++ CHANGELOG.md | 280 +++++++++++++++ README.md | 4 + build/release.sh | 12 +- package.json | 2 + yarn.lock | 676 ++++++++++++++++++++++++++++++++++- 7 files changed, 1089 insertions(+), 11 deletions(-) create mode 100644 .github/commit-convention.md create mode 100644 .github/contributing.md create mode 100644 CHANGELOG.md diff --git a/.github/commit-convention.md b/.github/commit-convention.md new file mode 100644 index 000000000..1533ef1af --- /dev/null +++ b/.github/commit-convention.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|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/ +``` + +#### Examples + +Appears under "Features" header, `store` subheader: + +``` +feat(store): add 'watch' option +``` + +Appears under "Bug Fixes" header, `module` subheader, with a link to issue #28: + +``` +fix(module): handle state overwrite + +close #28 +``` + +Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation: + +``` +perf: improve store getters performance 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(store): add 'watch' 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**: + +``` +(): + + + +