2023-05-12 开启多语言插件支持……

简单整理git 注释规范分享

git 苏 demo 3114℃

commit sample:
<type>(scope):<subject>
//空一行
<body>

示例:
feat 销退差异确认: 新增销退差异确认功能
//空一行 \n 略略路….
详细描述信息
说明信息补充:
type 为必须项,用于说明属于哪种类别。
基本类别如下:
feat: 新功能(feature)
fix: 修补
docs: 文档(documentation)
style: 格式(样式)
refactor: 重构(这个需要注意)
test: 增加测试
chore: 小改动(一般为一两行的改动,或者连续提交几次的小改动)
revert: 撤销之前的提交
upgrade:升级改造
bugfix: 修补bug
optimize: 功能优化
perft : 代码性能提升调整
br: 针对指定bug号,用于与测试沟通bug修改情况

scope 作用域 ,常用语描述此次commit的影响范围。
subject 必需项, 用于此次commit的简短描述,一般不超过50个字符,一般以动词开通,使用第一人称、现在时。 第一个字母小写,结尾不加句号(.)
body 可选项,用于详细描述,多个可以分成多行。

更多可以参见:
https://gitee.com/help/articles/4231#article-header1

打赏

转载请注明:苏demo的别样人生 » 简单整理git 注释规范分享

   如果本篇文章对您有帮助,欢迎向博主进行赞助,赞助时请写上您的用户名。
支付宝直接捐助帐号oracle_lee@qq.com 感谢支持!
喜欢 (2)or分享 (0)