367 words
2 minutes
约定式提交
Waiting for api.github.com...
在 Git Commits 中,约定式提交是一种常用的规范化提交信息的方式,使用通俗易懂的提交信息能够在版本管理中带来效率提升
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
约定式提交的格式如上,其中: <type> (必须): 常用的类型有:
类型 | 描述 |
---|---|
build | 构建 |
chore | 构建过程或辅助工具 |
ci | 持续集成 |
docs | 文档 |
feat | 新功能 |
fix | bug 修复 |
perf | 性能相关 |
refactor | 重构 |
revert | 版本回退 |
style | 代码格式 |
test | 增加测试 |
其他的类型在约定式提交中并没有强制的限制,但可以给提交类型添加一个围在括号内的范围,并提供额外的信息,如:
feat(parser): adds ability to parse arrays.
在脚注中包含BREAKING CHANGE
或在提交类型后加上!
表示一个破坏性的更改
<description>:
即此次此提交的描述信息,需要简明而易懂
在提交类型或者提交信息的:
后面必须有一个空格,并且描述信息需以小写字母开头
[optional body]
在简短的 description 后,可以编写较长的正文来提供额外的信息,但正文必须起始于秒速字段结束后的一个空行后
[optional footer(s)]
在正文结束的一个空行后,可以编写一行或多行脚注,后面跟:<space>
或<space>#
作为分隔符
脚注的令牌必须使用-
作为连字符