概述
使用git commit template
可以规范我们在IDEA提交代码是的注释规范,使用效果如下:
首先提交时,点击如下图标:
填写提交内容影响类型、影响范围、短注释、长注释等:
填写完后,自动生成模板:
安装步骤
打开settings
下的plugin
里搜索git commit template
插件:
安装完后重启IDEA就可以愉快的使用了。
参数详解
例子:
fix(DAO):用户查询缺少username属性 feat(Controller):用户查询接口开发
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。
scope(可选)
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
subject(必须)
subject是commit目的的简短描述,不超过50个字符。
- 建议使用中文。
- 结尾不加句号或其他标点符号。
根据以上规范git commit message将是如下的格式: