Git Commit Log提交规范

 我来答
青柠姑娘17
2022-08-20 · TA获得超过1.2万个赞
知道大有可为答主
回答量:6840
采纳率:100%
帮助的人:40.4万
展开全部

commit message 最好是结构化表达,让每一位阅读者都能看明白是做什么事情。

精简版:

专业版:

用于说明git commit的类别,只允许使用下面的标识。

feat:新功能(feature)。

fix/to:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。

docs:文档(documentation)。

style:格式(不影响代码运行的变动)。

refactor:重构(即不是新增功能,也不是修改bug的代码变动)。

perf:优化相关,比如提升性能、体验。

test:增加测试。

chore:构建过程或辅助工具的变动。

revert:回滚到上一个版本。

merge:代码合并。

sync:同步主线或分支的Bug。

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

例如在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。如果你的修改影响了不止一个scope,你可以使用*代替。

subject是commit目的的简短描述,不超过50个字符。

建议使用中文(感觉中国人用中文描述问题能更清楚一些)。

改动内容多的话,可以换行继续描述详细改动

有不兼容场景用Breaks结尾。

在本地.git/hooks/文件夹, commit-msg.sample 改名为commit-msg。

然后sudo vim把以下shell copy到commit-msg。

不规范提交:header填写xx(util)试试

image.png

也可以用maven plugin动态生成shell,这样可以持久化check功能到git。

已赞过 已踩过<
你对这个回答的评价是?
评论 收起
推荐律师服务: 若未解决您的问题,请您详细描述您的问题,通过百度律临进行免费专业咨询

为你推荐:

下载百度知道APP,抢鲜体验
使用百度知道APP,立即抢鲜体验。你的手机镜头里或许有别人想知道的答案。
扫描二维码下载
×

类别

我们会通过消息、邮箱等方式尽快将举报结果通知您。

说明

0/200

提交
取消

辅 助

模 式