使用git管理代码的同行,我们经常能看到其他人代码提交时的备注写的过长,有的看不懂,有的太过简洁,本文旨在简单说明git commit提交的规范,规范提交内容。
提交格式<type>(<scope>): <subject>
格式对应说<commit类型>(影响范围可选): 具体描述
举例 fix(DAO): 修复xxBug。
类型 | 说明 |
feat | 新功能 |
fix | 修补bug |
docs | 文档 |
style | 格式(不影响代码运行的变动) |
refactor | 重构(即不是新增功能,也不是修改bug的代码变动) |
test | 增加测试 |
chore | 构建过程或辅助工具的变动 |
perf | 性能优化 |
build | 打包 |
ci | 持续集成 |
scope用于说明 commit 影响的范围,根据不同项目有不同层次描述。若没有特殊规定,也可以描述影响的哪些功能等。
subject是 commit 目的的简短描述,不超过50个字符。
- 以动词开头,使用第一人称现在时,比如change
- 结尾不加标点符号
- 第一个字母小写?
fix(mybatis):修复sql查询bug