元作者: 阮一峰
元文鏈接:http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
其中,Header 是必需的,Body 和 Footer 可以省略。
不管是哪一个部分,任何一行都不得超过72个字符(或100个字符)。这是为了避免自动换行影响美观。
Header(必需)
-
type
(必需) 用于说明 commit 的类别- feat:新功能(feature)
- fix:修补bug
- docs:文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- test:增加测试
- chore:构建过程或辅助工具的变动
- revert:用于以前的 commit,则必须以
revert:
开头,后面跟着被撤销 Commit 的 Header。
revert: feat(pencil): add 'graphiteWidth' option This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Body部分的格式是固定的,必须写成
This reverts commit <hash>.
,其中的hash
是被撤销 commit 的 SHA 标识符。如果当前 commit 与被撤销的 commit,在同一个发布(release)里面,那么它们都不会出现在 Change log 里面。如果两者在不同的发布,那么当前 commit,会出现在 Change log 的
Reverts
小标题下面。如果
type
为feat
和fix
,则该 commit 将肯定出现在 Change log 之中。其他情况(docs
、chore
、style
、refactor
、test
)由你决定,要不要放入 Change log,建议是不要。 scope
用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。-
subject
(必需) 是 commit 目的的简短描述,不超过50个字符。- 以动词开头,使用第一人称现在时,比如
change
,而不是changed
或changes
- 第一个字母小写
- 结尾不加句号(
.
)
- 以动词开头,使用第一人称现在时,比如
Body(可選)
Body 部分是对本次 commit 的详细描述,可以分成多行。
有两个注意点:
- 使用第一人称现在时,比如使用
change
而不是changed
或changes
。 - 应该说明代码变动的动机,以及与以前行为的对比。
Footer(可選)
Footer 部分只用于两种情况。
-
不兼容变动
如果当前代码与上一个版本不兼容,则 Footer 部分以
BREAKING CHANGE
开头,后面是对变动的描述、以及变动理由和迁移方法。 -
关闭 Issue
如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。
Closes #234
也可以一次关闭多个 issue 。
Closes #123, #245, #992