为什么要有提交规范
在项目开发中,只要涉及到源码管理一般都会采用 Git 这类版本控制工具来管理,但是如果项目中的参与人员较多,每个开发人员向 Git 仓库中提交的 commit message 没有统一的格式的话,那么对于整个 git log 来说那真是什么“妖魔鬼怪”都有了, 好的提交规范不仅赏心悦目更方便项目管理,追踪复查问题,减少管理成本。
提交案例
错误的提交案例
从下面的截图的提交日志中,压根无法得知每次提交的目的是什么,甚至看的云里雾里。
良好的提交案例
从下面的截图的提交日志中,可以很清晰的得出此次提交的目的是新增功能还是修复 bug,涉及的模块和具体的改动。
规范的Git提交描述格式
一个好的提交信息都应该包含提交类型、一个简洁的主题和一个详细的描述,推荐的提交信息格式如下:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
type 代表提交类型,scope 代表受本次提交影响的范围,subject 代表本次提交简单的主题,LANK LINE 表示空行, body是提交的详细描述,footer 是与本次提交关联的元数据信息,如:需求单的链接或者 bug 清单的链接。
常见的提交类型(type):
- feat:新功能
- fix:bug 修复
- docs:文档修改
- style:格式修改
- refactor:代码重构
- test:测试
- perf:性能提升
- build:系统构建
- ci:ci 配置
- revert:回滚版本
- chore: 其他修改,比如辅助工具等
IDEA 配置提交格式
IDEA 中提供了 Git Commit Message Helper
插件来配置 Git 提交信息模板。
安装插件
IDEA Plugins 中搜索 Git Commit Message Helper
点击 **Install,**安装完成后可在 Other Settings
找到 Git Commit Message Helper
进行配置。
插件使用
在提交代码,编写 message 时点击上方的小图标,可通过插件填写 message 信息,点击 ok 会生成好 message 到输入框中,再点击提交即可。