目录
一、为什么要制定提交规范?
- 便于程序员对提交历史进行追溯,了解发生了什么情况。
- 一旦约束了 Commit Message ,意味着我们将慎重的进行每一次提交,不能再一股脑的把各种各样的改动都放在一个git commit里面,这样一来整个代码改动的历史也将更加清晰。
- 格式化的 Commit Message 才可以用于自动化输出 Change log 。
二、如何制定提交规范?
业界通用的Git提交规范:
<type>(<scope>):<subject>
- type
- 作用
- 用于说明 Git Commit 的类别,只允许使用下面的标识。
- 标识
- sync:同步主线或分支的bug。
- merge:代码合并。
- revert:回滚到上一个版本。
- chore:构建过程或辅助工具的变动。
- test:增加测试。
- perf:优化相关,比如提升性能、体验。
- refactor:重构(既不是新增功能,也不是修改bug的代码变动)。
- style:格式(不影响代码运行的变动)。
- docs:文档(documentation)。
- fix / to:修复bug,可以是QA(Quality Assurance)发现的bug,也可以是研发自己发现的bug。
- feat:新功能(feature)。
- 作用
- scope
- 作用
- scope用于说明 Commit 影响的范围,比如数据层、控制层、视图层等,视项目不同而不同。
- 例子
- 在JAVA,可以是Controller,Service,Dao等。
- 在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。
- 如果你的修改影响了不止一个scope,你可以使用*代替。
- 作用
- subject
- 作用
- subject是 Commit 目的的简短描述,一般不超过50个字符。
- 注意事项
- 建议使用中文。
- 结尾不加句号或其他标点符号。
- 作用
三、具体案例
feat(Controller):用户查询接口开发
fix(Dao):用户查询缺少username属性
以上就是Git的提交规范和具体案例,如果本篇文章对你有帮助,请一键三连支持,谢谢。