Commit Mesage 格式

完整格式

Commit Message应包括三个部分:Header(必需),Body(可选)和 Footer(可选)。

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
 




1
2
3
4
5

完整的示例:

fix(go/1.1.1): 修订条目内容
 
- 修正代码示例缩进问题
 
Close #1
1
2
3
4
5

Header 部分只有一行,包括三个字段:type(必需)、scope(可选)和 subject(必需)

1.type

type 用于说明 commit 的类别,只允许使用下面7个标识:

feat:新功能(feature)
fix:修补bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动),注意不是css修改(例如分号修改)
refactor:重构(即不是新增功能,也不是修改bug的代码变动。在不影响代码内部行为、功能下的代码修改)
test:增加测试
chore:构建过程或辅助工具的变动,或其他修改(不在上述类型中的修改)

 
 



 
1
2
3
4
5
6
7

2.scope

scope 用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

3.subject

subject是 commit 目的的简短描述,不超过50个字符。

以动词开头,使用第一人称现在时,比如change,而不是changed或changes
第一个字母小写
结尾不加句号(.)
1
2
3

Body

Body 部分是对本次 commit 的详细描述,可以分成多行。

Footer 部分是一些备注,通常用于描述关闭 Issue不兼容变动 (以BREAKING CHANGE开头,加上描述内容)。

如果当前 commit 针对某个issue,可以在 Footer 部分关闭这个 issue 。

# 关闭单个 issue
Closes #234

# 关闭多个 issue
Closes #123, #245, #992
1
2
3
4
5

参考资料