git的commit规范
转自:https://zhuanlan.zhihu.com/p/182553920,写的很好!
1. commit message
一次git commit提交的信息量很大,有作者信息、代码库信息、commit等信息。需要提交规范:
<type>(<scope>): <subject>
1.1 type :
用于说明git commit的类别,只允许使用下面的标识。
- feat:新功能(feature)
- fix/to:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG:【这个不太懂】
-
- fix:产生diff并自动修复此问题。适合于一次提交直接修复问题
- to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
- docs:文档(documentation)。
- style:格式(不影响代码运行的变动)【比如说加注释就是这个?】
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)。
- perf:优化相关,比如提升性能、体验。
- test:增加测试。
- chore:构建过程或辅助工具的变动。
- revert:回滚到上一个版本。
- merge:代码合并。
- sync:同步主线或分支的Bug。
1.2 scope 可选
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
1.3 subject
subject是commit目的的简短描述,不超过50个字符。结尾不加句号或其他标点符号。例子:
fix(DAO):用户查询缺少username属性
feat(Controller):用户查询接口开发
hook方式可用于自动判断提交的commit是否合格。