From 5f56a55bf1a625da1a8e90069fc226d09f983656 Mon Sep 17 00:00:00 2001 From: Kia King Ishii Date: Fri, 20 Nov 2020 01:30:25 +0900 Subject: [PATCH 01/48] chore: add more info to README and other guides --- .github/commit-convention.md | 91 +++++++++++++++++++++++++++++ .github/contributing.md | 109 +++++++++++++++-------------------- README.md | 12 +++- 3 files changed, 147 insertions(+), 65 deletions(-) create mode 100644 .github/commit-convention.md diff --git a/.github/commit-convention.md b/.github/commit-convention.md new file mode 100644 index 00000000..40b187d6 --- /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, `theme` subheader: + +``` +feat(theme): add home page feature +``` + +Appears under "Bug Fixes" header, `theme` subheader, with a link to issue #28: + +``` +fix(theme): remove underline on sidebar hover style + +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(theme): add home page feature + +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**: + +``` +(): + + + +