This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-dashboard.git
The following commit(s) were added to refs/heads/master by this push:
new 4700d6f docs: remove commit-convention.md (#1382)
4700d6f is described below
commit 4700d6f483d880eb9b19253f24903ddc6adbc09f
Author: guoqqqi <[email protected]>
AuthorDate: Thu Jan 28 22:42:51 2021 +0800
docs: remove commit-convention.md (#1382)
---
.github/commit-convention.md | 89 --------------------------------------------
web/scripts/verifyCommit.js | 11 +++---
2 files changed, 5 insertions(+), 95 deletions(-)
diff --git a/.github/commit-convention.md b/.github/commit-convention.md
deleted file mode 100644
index e98b85f..0000000
--- a/.github/commit-convention.md
+++ /dev/null
@@ -1,89 +0,0 @@
-## 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, `compiler` subheader:
-
-```
-feat(compiler): add 'comments' option
-```
-
-Appears under "Bug Fixes" header, `v-model` subheader, with a link to issue
#28:
-
-```
-fix(v-model): handle events on blur
-
-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**:
-
-```
-<type>(<scope>): <subject>
-<BLANK LINE>
-<body>
-<BLANK LINE>
-<footer>
-```
-
-The **header** is mandatory and the **scope** of the header is optional.
-
-### Revert
-
-If the commit reverts a previous commit, it should begin with `revert:`,
followed by the header of the reverted commit. In the body, it should say:
`This reverts commit <hash>.`, where the hash is the SHA of the commit being
reverted.
-
-### Type
-
-If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog.
However, if there is any [BREAKING CHANGE](#footer), the commit will always
appear in the changelog.
-
-Other prefixes are up to your discretion. Suggested prefixes are `docs`,
`chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
-
-### Scope
-
-The scope could be anything specifying the place of the commit change. For
example `core`, `compiler`, `ssr`, `v-model`, `transition` etc...
-
-### Subject
-
-The subject contains a succinct description of the change:
-
-- use the imperative, present tense: "change" not "changed" nor "changes"
-- don't capitalize the first letter
-- no dot (.) at the end
-
-### Body
-
-Just as in the **subject**, use the imperative, present tense: "change" not
"changed" nor "changes". The body should include the motivation for the change
and contrast this with previous behavior.
-
-### Footer
-
-The footer should contain any information about **Breaking Changes** and is
also the place to reference GitHub issues that this commit **Closes**.
-
-**Breaking Changes** should start with the word `BREAKING CHANGE:` with a
space or two newlines. The rest of the commit message is then used for this.
diff --git a/web/scripts/verifyCommit.js b/web/scripts/verifyCommit.js
index cf7c615..b59e3c6 100644
--- a/web/scripts/verifyCommit.js
+++ b/web/scripts/verifyCommit.js
@@ -33,12 +33,11 @@ if (!commitRE.test(msg)) {
console.log();
console.error(
` ${chalk.bgRed.white(' ERROR ')} ${chalk.red(`invalid commit message
format.`)}\n\n` +
- chalk.red(
- ` Proper commit message format is required for automated changelog
generation. Examples:\n\n`,
- ) +
- ` ${chalk.green(`feat(compiler): add 'comments' option`)}\n` +
- ` ${chalk.green(`fix(v-model): handle events on blur (close
#28)`)}\n\n` +
- chalk.red(` See .github/commit-convention.md for more details.\n`),
+ chalk.red(
+ ` Proper commit message format is required for automated changelog
generation. Examples:\n\n`,
+ ) +
+ ` ${chalk.green(`feat(compiler): add 'comments' option`)}\n` +
+ ` ${chalk.green(`fix(v-model): handle events on blur (close #28)`)}\n\n`
);
process.exit(1);
}
