安装:
去IDEA插件应用商城下载。
简介:
Git Commit message规范采用的是Angular 规范
Angular规范中定义的格式有3个内容:
Header |
|- type(必需) : Type of change:commit的类别;
|- scope(可选):Scope of this change:此次commit的影响模块;
|- subject(必需):Short description:简短的描述此次代码变更的主要内容
Body |
| - 对本次 commit 的详细描述
Footer |
| - 日常项目中开发,Footer不常用,可为空
1、Header
(1)type
type用于说明commit的类别,常用的标识如下:
- feat:新功能
- fix:修补bug
- docs:文档
- style: 格式(不影响代码运行的变动,空格,格式化,等等)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- perf: 性能 (提高代码性能的改变)
- test:增加测试或者修改测试
- build: 影响构建系统或外部依赖项的更改(maven,gradle,npm 等等)
- ci: 对CI配置文件和脚本的更改
- chore:对非 src 和 test 目录的修改
- revert: Revert a commit
(2)scope
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
(3)subject
subject是 commit 目的的简短描述,不超过50个字符,主要介绍此次代码变更的主要内容。
2、Body
Body 部分是对本次 commit 的详细描述,可以分成多行。
例如:
-修改菜单查询接口
-增加菜单删除接口
日常项目开发中,如果Header中subject已经描述清楚此次代码变更的内容后,Body部分就可以为空。
3、Footer
(1)不兼容变动
(2)关闭 Issue
日常项目中开发,Footer不常用,可为空。
撤销:
若需要撤销上一次的commit,header部分为:revert: 上一次commit的header内容;
body部分为:This reverts commit xxx,xxx是上一次commit对应的SHA 标识符。
使用:
提交的时候点击下图按钮,即可出现模板:
选择Type,填写相应内容,最后点击提交即可:
注:实践才是应用的最高境界,大家应大胆去试。