我们在日常使用Git提交代码时经常会写 commint message,否则就不允许提交。
一般来说,commit message 应该清晰明了,说明本次提交的目的。
目前,社区有多种 Commit message 的写法规范。本文介绍Angular 规范,这是目前使用最广的写法,比较合理和系统化,并且有配套的工具。
1.提供更多的历史信息,方便快速浏览。
2.可以过滤某些commit(比如文档改动),便于快速查找信息。
3.可以直接从commit生成Change log。
4.对 Code Review 友好。
如果使用 IDEA 开发,我们可以先装个插件: Git Commit Template
装完之后重启IDEA,如果我们提交代码会发现多了一个按钮:
点击之后就会出现一个 Commit Template,主要分为下面三个部分: Header, Body,Footer。
// 空一行
// 空一行
下面详细解释下个个部分的含义。
Header的部分只有一行,包括三个字段: type(必需), scope(可选), subject(必需)
对应到idea插件上图的配置分别为 Header部分的:
type(必需) |
Type of change |
commit类别 |
scope(可选) |
Scope of this change |
commint影响的范围 |
subject(必需) |
Short description |
简短的描述 |
feat:新增功能(feature)
fix:修补补丁(bug)
docs:修订文档,如 Readme, Change Log, Contribute 等(documentation)
style: 格式(仅调整空格、格式缩进等(不改变代码逻辑的变动))
refactor:代码重构,未新增任何功能和修复任何 bug
perf: 性能 (优化相关,改善性能和体验的修改)
test:增加测试用例或者修改测试用例
build: 改变构建流程,新增依赖库、工具等(maven,gradle,npm 等等)
ci: 对CI配置文件和脚本的更改,自动化流程配置修改
chore:对非 src 和 test 目录的修改
revert: 回滚到上一个版本
merge: 合并分支或冲突等
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
subject是 commit 目的的简短描述,不超过50个字符。
以动词开头,使用第一人称现在时,比如change,而不是changed或changes
第一个字母小写
结尾不加句号(.)
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
有两个注意点。
(1)使用第一人称现在时,比如使用change而不是changed或changes。
(2)应该说明代码变动的动机,以及与以前行为的对比。
Footer 部分只用于两种情况。
如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。
BREAKING CHANGE: isolate scope bindings definition has changed.
To migrate the code follow the example below:
Before:
scope: {
myAttr: 'attribute',
}
After:
scope: {
myAttr: '@',
}
The removed `inject` wasn't generaly useful for directives so there should be no code using it.
如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。
Closes #234
也可以一次关闭多个 issue 。
Closes #123, #245, #992
最后, 一个完整的commit message示例可能如下: