一、格式
<type>: <subject>
例如 fix:解决用户点击登录无响应的问题
二、详细说明
1、type
:用于说明提交类型
bash
feat - 增加新功能、新需求
fix - 修复bug, 可以是测试发现的bug, 也可以是研发自己发现的bug
style - 不影响代码运行的变动, 主要是代码风格相关的提交, 例如代码格式化、去掉空格、改变缩进、增删分号等
refactor - 代码重构 ( 即不是新增功能, 也不是修改bug的代码变动 )
perf - 优化相关, 比如提升性能、体验
test - 增加单元测试等代码
build - 构建时使用, 例如发布版本, 调整依赖时
docs - 添加文档注释, 主要用来描述文档的变更
revert - 回退
chore - 构建过程或辅助工具的变动, 比如之前用Maven, 后面换成了Gradle
一般情况下使用 feat
、fix
即可
2、subject
:本次提交的简短描述,一般不超过50个字符
- 描述应有意义,避免出现如:修改、接口重写、修改pom文件等无意义内容
- 描述应与提交内容相符
- 结尾不加句号或其他标点符号