❧ git commit提交规范
基本格式
<type>[optional scope]: <description>[optional body][optional footer(s)]说明
- type: commit的类型
- scope: commit影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同
- description: commit目的的简短描述
- body: commit的详细描述,可以分成多行
- footer: 一些备注,通常是BREAKING CHANGE或修复的bug的链接
案例
feat(user): 新增用户注册功能
- 新增用户注册功能- 新增用户注册功能- 新增用户注册功能
BREAKING CHANGE:
- 新增用户注册功能- 新增用户注册功能- 新增用户注册功能
Fixes #123
Closes #123BREAKING CHANGE 用来明确指出一个提交引入了破坏性变更(即不兼容的API变更)
类型
feat: 新功能(feature)fix: 修补bugdocs: 文档(documentation)style: 格式(不影响代码运行的变动)refactor: 重构(即不是新增功能,也不是修改bug的代码变动)test: 增加测试chore: 不会影响到项目的输出(即不影响构建的产物),例如:.gitignore、ESLint配置、更新开发者文档等ci: 持续集成相关文件修改,自动部署或构建的脚步文件修改,例如:YAML、Dockerfilerevert: 回滚到上一个版本perf: 性能优化build: 构建系统或外部依赖的改动,比如gulp、broccoli、npm的配置文件和脚本的更改wip: 表示这部分工作尚未完成,可能需要进一步修改或完成才能被接受或合并(work in progress)style可以包括:
- 代码格式化更改,比如空格、缩进、换行的调整。
- 标点符号的添加或删除,例如分号的添加或删除。
- 代码注释的添加、更新或删除。
- 代码排列或组织的优化,不涉及代码逻辑的更改。
- 命名风格的统一,比如变量名和函数名的重新命名,以符合项目的命名约定。