Git commit规范

提交格式

注：? 表示可选，不输入 scope 时可省略圆括号。

type(scope?): subject
body?
footer?

type

type用于说明 commit 的类别，只允许使用下列值：

• build: 对项目构建系统或外部依赖项的更改。例如，修改构建脚本、配置文件等。

• chore: 非业务性的任务和更改。通常用于修改构建过程、辅助工具的代码，或者进行一些不涉及用户功能的工作。

• ci: 对持续集成 (Continuous Integration) 配置文件和脚本的更改。

• docs: 文档变更，包括但不限于 README 文件、文档生成器或注释的变更。

• feat: 新功能的添加。通常伴随着用户功能或其他明显的变更。

• fix: 修复 bug。

• perf: 改进性能的代码更改。

• refactor: 代码重构，不是修复 bug 也不是添加新功能的代码更改。

• revert: 撤销先前的提交。

• style: 与代码风格相关的更改，例如空格、格式化等，而不涉及功能性代码更改。

• test: 添加或修改测试。

body & footer

body用于提供更详细的说明，可以分成多行。

footer用于提供一些与提交信息不直接相关的信息，可以分成多行。

Example:

feat: 防止请求竞争
 
引入一个请求ID和对最新请求的引用。忽略除最新请求外的所有传入响应。
 
移除用于解决竞争问题但现在已过时的超时机制。
 
参考：#123

重大修改

当仓库产生比较重大的修改时，例如删除了某个 API，或者改变了大量的 API，可以通过一下两种方式来表示：

type!

在提交信息的type后面添加!符号，表示该提交是重大更改。

feat!: 新增了新的 API，移除了旧的 API

BREAKING CHANGE

在提交信息的body中添加BREAKING CHANGE，表示该提交是重大更改。

feat: 新增了新的 API
 
BREAKING CHANGE: 移除了旧的 API