Git代码提交规范
1、目的
- 统一开发规范,便于管理;
- 根据提交信息就可见名知其意;
- 方便检索提交历史(git log <last tag> HEAD --pretty=format:%s 或者用grep检索);
2、提交规范
- 提交的内容要保持原子性,也就是对于一个功能或者模块,至少要保证单元测试可以跑通并且没有代码报红;
- 代码扫描插件检查代码;
3、commit message 的格式
$ git commit -m "commit message"
message格式为:提交类型
(模块名称
):提交内容描述
- 提交类型及描述:
提交类型 | 描述 |
---|---|
feat | 新功能(feature),表示从无到有,新增的功能 |
fix | 修补bug |
docs | 文档(documentation) |
style | 格式(不影响代码运行的改动) |
refactor | 重构(既不是新增功能,也不是修改bug的代码改动),或者增强逻辑功能 |
test | 增加测试,一般是单测和功能代码一起提交用feat,但若后面补一些单测,用这个 |
chore | 构建过程或辅助工具的变动,比如:pom、Dockfile等文件的改动 |
- Eg:
feat(merchant-cen):新增商户