- Git是一款卓越的开源分布式版本控制系统,广泛应用于日常开发中, - 主要用于有效地管理代码的提交、还原和追踪。- 作为团队协作中不可或缺的代码管理工具,其功能和灵活性使其成为开发人员首选的工具之一。
- 在我们修改了代码并且提交之前,常会使用git commit -m 'change’命令来描述我们代码改动的内容, - 但是很多都不规范,随处可见的 git commit -m ‘update’,- 以致于不能清晰地知道每次提交代码的变更内容,所以需要一种规范来管理代码提交的内容。
一、 Git Commit message规范
一般来说,commit message应该清晰明了,说明本次提交的目的,具体做了什么操作,但是在日常开发中,大家的 commit message 千奇百怪,
中英文混合使用、fix bug等各种笼统的 message 司空见怪,这就导致后续代码维护成本特别大,
有时自己都不知道自己的fix bug修改的是什么问题。基于以上这些问题,
我们希望通过某种方式来监控用户的git commit message,让规范更好的服务于质量,提高大家的研发效率。
commit message格式
<type>(<scope>): <subject>
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 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
- 也可以标记为当前修改的文件(例如:docs(README.md): modify readme file)
例如:
在Angular,可以是location,browser,compile,compile,rootScope,
ngHref,ngClick,ngView等。如果你的修改影响了不止一个scope,你可以使用*代替。
subject(必须)
subject是commit目的的简短描述,不超过50个字符。
- 结尾不加句号或其他标点符号。
- 根据以上规范git commit message将是如下的格式:
fix(DAO):用户查询缺少username属性feat(Controller):用户查询接口开发
以上就是我们梳理的git commit规范
总结
git commit 益处:
- 便于程序员对提交历史进行追溯,了解发生了什么情况。
- 一旦约束了commit message,意味着我们将慎重的进行每一次提交,不能再一股脑的把各种各样的改动都放在一个git commit里面,这样一来整个代码改动的历史也将更加清晰。
- 格式化的commit message才可以用于自动化输出Change log。
二、插件Git Commit Template的使用
- idea安装git commit template插件
- 重启idea
- 勾选
use non-modal commit interface
- 选择要提交的文件
- 填写对应的内容并提交
版权归原作者 Terry.bb 所有, 如有侵权,请联系我们删除。