当前位置:   article > 正文

别乱提交代码了,看下大厂 Git 提交规范是怎么做的!(1)_代码提交信息规范

代码提交信息规范

“hooks”: {

“commit-msg”: “commitlint -e $GIT_PARAMS”

}

}

4. 使用

执行git cz进入interactive模式,根据提示依次填写

1.Select the type of change that you’re committing 选择改动类型 ()

2.What is the scope of this change (e.g. component or file name)? 填写改动范围 ()

3.Write a short, imperative tense description of the change: 写一个精简的描述 ()

4.Provide a longer description of the change: (press enter to skip) 对于改动写一段长描述 ()

5.Are there any breaking changes? (y/n) 是破坏性修改吗?默认n (

)

6.Does this change affect any openreve issues? (y/n) 改动修复了哪个问题?默认n (

)

生成的commit message格式如下:

(): 

填写完毕后,husky会调用commitlint对message进行格式校验,默认规定typesubject为必填项。

任何git commit指令的option都能用在 git cz指令上, 例如git cz -a

Commit message规范在rrd-fe落地使用情况


针对团队目前使用的情况,我们讨论后拟定了commit message每一部分的填写规则。推荐:Java进阶教程资料,公众号Java精选,回复Java面试,获取面试资料。

1. type

type为必填项,用于指定commit的类型,约定了featfix两个主要type,以及docs、style、build、refactor、revert五个特殊type其余type暂不使用。

# 主要type

feat:     增加新功能

fix:      修复bug

# 特殊type

docs:     只改动了文档相关的内容

style:    不影响代码含义的改动,例如去掉空格、改变缩进、增删分号

build:    构造工具的或者外部依赖的改动,例如webpack,npm

refactor: 代码重构时使用

revert:   执行git revert打印的message

# 暂不使用type

test:     添加测试或者修改现有测试

perf:     提高性能的改动

ci:       与CI(持续集成服务)有关的改动

chore:    不修改src或者test的其余修改,例如构建过程或辅助工具的变动

当一次改动包括主要type特殊type时,统一采用主要type

2. scope

scope也为必填项,用于描述改动的范围,格式为项目名/模块名,例如:node-pc/common rrd-h5/activity,而we-sdk不需指定模块名。如果一次commit修改多个模块,建议拆分成多次commit,以便更好追踪和维护。

3. body

body填写详细描述,主要描述改动之前的情况修改动机,对于小的修改不作要求,但是重大需求、更新等必须添加body来作说明。

4. break changes

break changes指明是否产生了破坏性修改,涉及break changes的改动必须指明该项,类似版本升级、接口参数减少、接口删除、迁移等。

0929627152787f54b462a184503b496f.png

5. affect issues

affect issues指明是否影响了某个问题。例如我们使用jira时,我们在commit message中可以填写其影响的JIRA_ID,若要开启该功能需要先打通jiragitlab。参考文档:docs.gitlab.com/ee/user/pro…

填写方式例如:

re #JIRA_ID

fix #JIRA_ID

示例

完整的commit message示例

23a7faf42ad885b4510e0fdc3c6118e2.png

相应的git log

2c4f9235614ad42da39c6d8715a2676d.png

作者:人人贷大前端技术中心

juejin.cn/post/6844903871832145927

精品资料,超赞福利!

>>Java精选面试题<< - 小程序,3000+ 道面试题在线刷,最新、最全 Java 面试题!

7eb0ce3a43000c459370c5fedc4aac4f.png

期往精选  点击标题可跳转

每月 5 号发工资和 25 号发工资,真能看出公司是否靠谱?

JDK 17 正式发布,Oracle 官宣免费提供!“新版任你发,我用JDK 8”或成历史?

如何写出别人无法维护的代码?走自己的路让别人无路可走,还不会被“打死”!

分布式事务最经典的 7 种解决方案,一文彻底搞懂!!

蚂蚁 4 面和体检都过了,最后却因背调挂了导致无业,网友:没养个“备胎”?

最后如何让自己一步步成为技术专家

说句实话,如果一个打工人不想提升自己,那便没有工作的意义,毕竟大家也没有到养老的年龄。

当你的技术在一步步贴近阿里p7水平的时候,毫无疑问你的薪资肯定会涨,同时你能学到更多更深的技术,交结到更厉害的大牛。

推荐一份Java架构之路必备的学习笔记,内容相当全面!!!

成年人的世界没有容易二字,前段时间刷抖音看到一个程序员连着加班两星期到半夜2点的视频。在这个行业若想要拿高薪除了提高硬实力别无他法。

你知道吗?现在有的应届生实习薪资都已经赶超开发5年的程序员了,实习薪资26K,30K,你没有紧迫感吗?做了这么多年还不如一个应届生,真的非常尴尬!

进了这个行业就不要把没时间学习当借口,这个行业就是要不断学习,不然就只能被裁员。所以,抓紧时间投资自己,多学点技术,眼前困难,往后轻松!

【关注】+【转发】+【点赞】支持我!创作不易!

mq-1714631933767)]

成年人的世界没有容易二字,前段时间刷抖音看到一个程序员连着加班两星期到半夜2点的视频。在这个行业若想要拿高薪除了提高硬实力别无他法。

你知道吗?现在有的应届生实习薪资都已经赶超开发5年的程序员了,实习薪资26K,30K,你没有紧迫感吗?做了这么多年还不如一个应届生,真的非常尴尬!

进了这个行业就不要把没时间学习当借口,这个行业就是要不断学习,不然就只能被裁员。所以,抓紧时间投资自己,多学点技术,眼前困难,往后轻松!

【关注】+【转发】+【点赞】支持我!创作不易!

本文已被CODING开源项目:【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/我家自动化/article/detail/685422
推荐阅读
相关标签
  

闽ICP备14008679号