在代码管理中,我们通常期望开发者在提交代码时能够按照一定的格式编写注释,这不仅方便开发者自己查看,也方便后续代码维护和问题查询。在云效的 Codeup 上提供了这样的功能:
以下面的例子我们讲述如何配置:
1、提交格式为:<type>(scope?): <subject>
2、type代表改动的类型,比如:新增、修改等,包含以下类型
- build: 编译相关的修改,例如发布版本、对项目构建或者依赖的改动
- chore: 其他修改, 比如改变构建流程、或者增加依赖库、工具等
- ci: 持续集成修改
- docs: 文档修改
- feat: 新特性、新功能
- fix: 修改bug
- perf: 优化相关,比如提升性能、体验
- refactor: 代码重构
- revert: 回滚到上一个版本
- style: 代码格式修改, 注意不是 css 修改
- test: 测试用例修改
3、scope代表一个可选的修改范围,用于标识此次提交主要涉及到代码中哪个模块。
4、subject为一句话描述此次提交的主要内容,做到言简意赅
正则如下:
(?i)(\W|^)(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(.*)?(:)(.)+(\W|$)
可成功提交的注释如下:
fix scope:subject for this fixbuild:subject for this building
不可成功提交的注释如下:
fix some bugstest:
需要注意的是,如果有一次注释出错后,您需要将错误的提交注释全部修改正确后才可以提交成功,因为在push的时候,检查的是每一个注释而不是最后一个注释。
- 修改最后一次注释
git commit --amend
将红框内的注释更正为匹配正则的后,退出保存即可。
- 修改多次注释
比如 commit 两次,那么可参考以下步骤进行修改:
#数字 n 可以换成你需要修改的提交次数,代表倒数第几次修改git rebase -i HEAD~n#本示例则为git rebase -i HEAD~2
将需要修改的注释前面的 pick 修改为 edit ,可同时在一次修改多条,修改后保存退出。
接着反复执行以下这组命令,直到所有修改 edit 的注释都修改完:
#以下命令表示一次注释修改git commit --amend git rebase --continue
再次 push 即可。