概述

约定式提交规范是一种基于提交信息的轻量级约定。

提交信息结构如下:

<类型>[可选 范围]: <描述>

类型说明：

1. fix: 类型 为 fix 的提交表示在代码库中修复了一个 bug

2. feat: 类型 为 feat 的提交表示在代码库中新增了一个功能

3. build: 用于修改项目构建系统，例如修改依赖库、外部接口或者升级 Node 版本等

4. chore: 用于对非业务性代码进行修改，例如修改构建流程或者工具配置等

5. ci: 用于修改持续集成流程，例如修改 github action、Jenkins 等工作流配置

6. docs: 用于修改文档，例如修改 README 文件、API 文档等

7. style: 用于修改代码的样式，例如调整缩进、空格、空行等

8. refactor: 用于重构代码，例如修改代码结构、变量名、函数名等但不修改功能逻辑

9. perf: 用于优化性能，例如提升代码的性能、减少内存占用等

10. test: 用于修改测试用例，例如添加、删除、修改代码的测试用例等

11. !: <类型>(范围) 后面有一个 ! 的提交，表示引入了破坏性 API 变更，破坏性变更可以是任意 类型 提交的一部分

约定式规范提交

1. 每个提交都必须使用类型字段前缀，它由一个名词构成，诸如 feat 或 fix ， 其后接可选的范围字段，可选的 !，以及必要的冒号（英文半角）和空格。

2. 范围字段可以跟随在类型字段后面。范围必须是一个描述某部分代码的名词，并用圆括号包围，例如： fix(parser):

3. 描述字段必须直接跟在 <类型>(范围) 前缀的冒号和空格之后。 描述指的是对代码变更的简短总结，例如： fix: array parsing issue when multiple spaces were contained in string 。

注

约定式规范参考连接