提交 | 用户 | age
|
ad3688
|
1 |
## Git Commit Message Convention |
V |
2 |
|
|
3 |
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular). |
|
4 |
|
|
5 |
#### TL;DR: |
|
6 |
|
|
7 |
Messages must be matched by the following regex: |
|
8 |
|
|
9 |
```js |
|
10 |
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip): .{1,50}/; |
|
11 |
``` |
|
12 |
|
|
13 |
#### Examples |
|
14 |
|
|
15 |
Appears under "Features" header, `dev` subheader: |
|
16 |
|
|
17 |
``` |
|
18 |
feat(dev): add 'comments' option |
|
19 |
``` |
|
20 |
|
|
21 |
Appears under "Bug Fixes" header, `dev` subheader, with a link to issue #28: |
|
22 |
|
|
23 |
``` |
|
24 |
fix(dev): fix dev error |
|
25 |
|
|
26 |
close #28 |
|
27 |
``` |
|
28 |
|
|
29 |
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation: |
|
30 |
|
|
31 |
``` |
|
32 |
perf(build): remove 'foo' option |
|
33 |
|
|
34 |
BREAKING CHANGE: The 'foo' option has been removed. |
|
35 |
``` |
|
36 |
|
|
37 |
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. |
|
38 |
|
|
39 |
``` |
|
40 |
revert: feat(compiler): add 'comments' option |
|
41 |
|
|
42 |
This reverts commit 667ecc1654a317a13331b17617d973392f415f02. |
|
43 |
``` |
|
44 |
|
|
45 |
### Full Message Format |
|
46 |
|
|
47 |
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**: |
|
48 |
|
|
49 |
``` |
|
50 |
<type>(<scope>): <subject> |
|
51 |
<BLANK LINE> |
|
52 |
<body> |
|
53 |
<BLANK LINE> |
|
54 |
<footer> |
|
55 |
``` |
|
56 |
|
|
57 |
The **header** is mandatory and the **scope** of the header is optional. |
|
58 |
|
|
59 |
### Revert |
|
60 |
|
|
61 |
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. |
|
62 |
|
|
63 |
### Type |
|
64 |
|
|
65 |
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. |
|
66 |
|
|
67 |
Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks. |
|
68 |
|
|
69 |
### Scope |
|
70 |
|
|
71 |
The scope could be anything specifying the place of the commit change. For example `dev`, `build`, `workflow`, `cli` etc... |
|
72 |
|
|
73 |
### Subject |
|
74 |
|
|
75 |
The subject contains a succinct description of the change: |
|
76 |
|
|
77 |
- use the imperative, present tense: "change" not "changed" nor "changes" |
|
78 |
- don't capitalize the first letter |
|
79 |
- no dot (.) at the end |
|
80 |
|
|
81 |
### Body |
|
82 |
|
|
83 |
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. |
|
84 |
|
|
85 |
### Footer |
|
86 |
|
|
87 |
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**. |
|
88 |
|
|
89 |
**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. |