约定式提交规范
约定式提交规范要求提交信息遵循以下格式:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
| 名称 | 描述 |
|---|---|
| Type-类型 | 表示提交的类型,如feat、fix、style等 |
| Scope-范围(可选) | 指定提交影响的代码模块或功能区域 |
| Description-描述 | 简短描述提交的内容 |
| Body-正文(可选) | 提供更详细的描述,如变更的原因、影响范围等。 |
| Footer-脚注(可选) | 提供额外信息,如关联的issue编号、破壊性变更的标记等。 |
类型
-
feat:新功能或功能变更相关
-
fix:修复bug相关
-
docs:改动了文档,注释相关
-
style:修改了代码格式化相关,如删除空格、改变缩进、单双引号切换、增删分号等,并不会影响代码逻辑
-
refactor:重构代码,代码结构的调整相关(理论上不影响现有功能)
-
perf:性能改动,性能、页面等优化相关
-
test:增加或更改测试用例,单元测试相关
-
build: 影响编译的更改相关,比如打包路径更改、npm过程更改等
-
ci:持续集成方面的更改。现在有些build系统喜欢把ci功能使用yml描述。如有这种更改,建议使用ci
-
chore:其它改动相关,比如文件的删除、构建流程修改、依赖库工具更新增加等
-
revert:回滚版本相关