ce4c83ff
 wxy
初始提交
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
# Commit规范
在对项目作出更改后，我们需要生成 commit 来记录自己的更改。以下是参照 Angular 对 commit 格式的规范：
## (1) 格式
提交信息包括三个部分：`Header`，`Body` 和 `Footer`。
```
<Header>
<Body>
<Footer>
```
其中，Header 是必需的，Body 和 Footer 可以省略。
#### 1> Header
Header 部分只有一行，包括俩个字段：`type`（必需）和`subject`（必需）。
```
<type>: <subject>
```
**type**
type 用于说明 commit 的类别，可以使用如下类别：
- feat：新功能（feature）
- fix：修补bug
- doc：文档（documentation）
- style： 格式（不影响代码运行的变动）
- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
- test：增加测试
- chore：构建过程或辅助工具的变动
**subject**
subject 是 commit 目的的简短描述。
- 以动词开头，使用第一人称现在时，比如改变，而不是改变了。
- 结尾不加句号（。）
#### 2> Body
Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。
```
More detailed explanatory text, if necessary. Wrap it to
about 72 characters or so.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Use a hanging indent
```
**注意：**应该说明代码变动的动机，以及与以前行为的对比。
#### 3> Footer
Footer 部分应该包含：(1)Breaking Changes; (2)关闭 issue；
**Breaking Changes**：
如果当前代码与上一个版本不兼容，则 Footer 部分以`BREAKING CHANGE`开头，后面是对变动的描述、以及变动理由和迁移方法。这种使用较少，了解即可。
**Issue 部分：**
- 通过 commit 关联 issue：
如果当前提交信息关联了某个 issue，那么可以在 Footer 部分关联这个 issue：
```
issue #2
```
- 通过 commit 关闭 issue，当提交到**默认分支**时，提交信息里可以使用 `fix/fixes/fixed` ， `close/closes/closed` 或者 `resolve/resolves/resolved`等关键词，后面再跟上 issue 号，这样就会关闭这个 issue：
```
Closes #1
```
注意，如果不是提交到默认分支，那么并不能关闭这个 issue，但是在这个 issue 下面会显示相关的信息表示曾经想要关闭这个 issue，当这个分支合并到默认分支时，就可以关闭这个 issue 了。
#### 4> 例子
下面是一个完整的例子：
```
feat: 添加了分享功能
给每篇文章添加了分享功能
- 添加分享到微信功能
- 添加分享到朋友圈功能
Issue #1, #2
Closes #1
```
|
