别乱提交代码了,看下大厂 Git 提交规范是怎么做的!
Git是现在市面上最流行的版本控制工具,书写良好的commit message能大大提高代码维护的效率。
但是在日常开发中由于缺少对commit message的约束,导致填写内容随意、质量参差不齐,可读性低亦难以维护。
在项目中引入commit message规范已是迫在眉睫。
用什么规范?
Quick Start
1. 全局安装commitizen & cz-conventional-changelog
2. 项目内安装commitlint & husky
3. 添加相应配置
4. 使用
Commit message规范在rrd-fe落地使用情况
1. type
2. scope
3. body
4. break changes
5. affect issues
示例
扩展阅读
用什么规范?
现在市面上比较流行的方案是约定式提交规范
(Conventional Commits
),它受到了Angular提交准则
的启发,并在很大程度上以其为依据。约定式提交规范
是一种基于提交消息的轻量级约定。
它提供了一组用于创建清晰的提交历史的简单规则;这使得编写基于规范的自动化工具变得更容易。这个约定与SemVer
相吻合,在提交信息中描述新特性、bug 修复和破坏性变更。
它的 message 格式如下:
<类型>[可选的作用域]: <描述>
[可选的正文]
[可选的脚注]
Quick Start
1. 全局安装commitizen & cz-conventional-changelog
commitizen
是一个撰写合格commit message
的工具,用于代替git commit
指令,而cz-conventional-changelog
适配器提供conventional-changelog标准(约定式提交标准)。
基于不同需求,也可以使用不同适配器。
npm install -g commitizen cz-conventional-changelogecho '{ "path": "cz-conventional-changelog" }' > ~/.czrc
安装完毕后,可直接使用git cz
来取代git commit
。
全局模式下,需要 ~/.czrc
配置文件, 为commitizen
指定Adapter
。
关注微信公众号:Java技术栈,在后台回复:git,可以获取我整理的 N 篇最新Git 教程,都是干货。
2. 项目内安装commitlint & husky
commitlint
负责用于对commit message
进行格式校验,husky
负责提供更易用的git hook
。
Use npm
npm i -D husky @commitlint/config-conventional @commitlint/cli
Use yarn
yarn add husky @commitlint/config-conventional @commitlint/cli -D
commitlint
只能做格式规范,无法触及内容。对于内容质量的把控只能靠我们自己。
3. 添加相应配置
创建commitlint.config.js
# In the same path as package.json
echo 'module.exports = {extends: ["@commitlint/config-conventional"]};' > ./commitlint.config.js
引入husky
# package.json
...,"husky": { "hooks": { "commit-msg": "commitlint -e $GIT_PARAMS" }}
4. 使用
执行git cz
进入interactive模式,根据提示依次填写
1.Select the type of change that you're committing 选择改动类型 (<type>)
2.What is the scope of this change (e.g. component or file name)? 填写改动范围 (<scope>)
3.Write a short, imperative tense description of the change: 写一个精简的描述 (<subject>)
4.Provide a longer description of the change: (press enter to skip) 对于改动写一段长描述 (<body>)
5.Are there any breaking changes? (y/n) 是破坏性修改吗?默认n (<footer>)
6.Does this change affect any openreve issues? (y/n) 改动修复了哪个问题?默认n (<footer>)
生成的commit message格式如下:
<type>(<scope>): <subject><BLANK LINE><body><BLANK LINE><footer>
填写完毕后,husky
会调用commitlint
对message进行格式校验,默认规定type
及subject
为必填项。
任何git commit
指令的option
都能用在 git cz
指令上, 例如git cz -a
Commit message规范在rrd-fe落地使用情况
针对团队目前使用的情况,我们讨论后拟定了commit message
每一部分的填写规则。大牛总结的 Git 使用技巧,这篇推荐大家看下。
1. type
type
为必填项,用于指定commit的类型,约定了feat
、fix
两个主要type
,以及docs、style、build、refactor、revert五个特殊type
,其余type
暂不使用。
# 主要typefeat: 增加新功能fix: 修复bug
# 特殊typedocs: 只改动了文档相关的内容style: 不影响代码含义的改动,例如去掉空格、改变缩进、增删分号build: 构造工具的或者外部依赖的改动,例如webpack,npmrefactor: 代码重构时使用revert: 执行git revert打印的message
# 暂不使用typetest: 添加测试或者修改现有测试perf: 提高性能的改动ci: 与CI(持续集成服务)有关的改动chore: 不修改src或者test的其余修改,例如构建过程或辅助工具的变动
当一次改动包括主要type
与特殊type
时,统一采用主要type
。Git 的这个神技,学会爽歪歪~这篇推荐阅读。
2. scope
scope
也为必填项,用于描述改动的范围,格式为项目名/模块名,例如:
node-pc/common
rrd-h5/activity
,而we-sdk
不需指定模块名。如果一次commit修改多个模块,建议拆分成多次commit,以便更好追踪和维护。
3. body
body
填写详细描述,主要描述改动之前的情况
及修改动机
,对于小的修改不作要求,但是重大需求、更新等必须添加body来作说明。
4. break changes
break changes
指明是否产生了破坏性修改,涉及break changes的改动必须指明该项,类似版本升级、接口参数减少、接口删除、迁移等。
5. affect issues
affect issues
指明是否影响了某个问题。例如我们使用jira时,我们在commit message
中可以填写其影响的JIRA_ID
,若要开启该功能需要先打通jira
与gitlab
。
参考文档:
https://docs.gitlab.com/ee/user/project/integrations/jira.html
填写方式例如:
re #JIRA_IDfix #JIRA_ID
示例
完整的commit message示例
相应的git log
扩展阅读
conventional commits 必读
介绍约定式提交标准。
https://www.conventionalcommits.org/zh/v1.0.0-beta.3/
Angular规范 必读
介绍Angular标准每个部分该写什么、该怎么写。
https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines
@commitlint/config-conventional 必读
介绍commitlint的校验规则config-conventional,以及一些常见passes/fails情况。
https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional
来源:人人贷大前端技术中心
juejin.im/post/5d0b3f8c6fb9a07ec07fc5d0
- END -
如果看到这里,说明你喜欢这篇文章,请转发、点赞。扫描下方二维码或者微信搜索「perfect_iscas」,添加好友后即可获得10套程序员全栈课程+1000套PPT和简历模板,向我私聊「进群」二字即可进入高质量交流群。
↓扫描二维码进群↓
喜欢文章,点个在看
别乱提交代码了,看下大厂 Git 提交规范是怎么做的!相关推荐
- idea怎么提交到dev分支_IDEA设置git提交分支
这篇随笔包含几个点 1.如何设置默认提交远端分支 2.如何切换本地/远端分支 3.无法切换远端分支报错 最近代码重新Clone下来,改完提交代码的时候,总会默认提交到master分支上,并非自己的开发 ...
- centos7下使用git提交代码
配置操作: 查看配置 git config --list 全局配置 git config --global user.name "username" git config --gl ...
- 如何向Linux内核提交代码,如何往 Linux 内核社区提交代码
总有这样一群人,不计报酬不辞辛苦的为这个世界的美好添砖加瓦,在这一类人中的某一些人,他们开创了许多伟大的开源工程,这些工程也许会随着年代的久远逐渐被替代,但仍然有一些随着时光流逝变得愈发强大,这其中就 ...
- 有效的避免代码提交冲突,有效的避免git提交冲突
Microsoft Windows [版本 10.0.17763.1577] (c) 2018 Microsoft Corporation.保留所有权利.D:\work\HCC\platform> ...
- idea忽略文件不提交git_你可能会忽略的 Git 提交规范
一.为什么需要规范? 无规矩不成方圆,编程也一样. 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,没有人可以干预你.可是如果在团队协作中,大家都张扬个性,那么代码将会是一团糟,好好的项目 ...
- git提交emoji_Emoji-Log:一种编写Git提交消息的新方法
git提交emoji 我是一个全职的开源开发人员,或者,我喜欢称呼它为
- eclipse git提交代码_来看看大厂的Git提交规范,千万别乱提交代码哦...
点击上方"小黄鸭编程社区",选择"星标" 作者:人人贷大前端技术中心来源:https://urlify.cn/3a6NNb git是现在市面上最流行的版本控制工 ...
- git第一次提交代码到码云,git pull 报错:fatal: refusing to merge unrelated histories
第一次提交的步骤: 1.进入项目目录,执行 git init 2.连接远程仓库 git remote add origin 远程仓库地址(从码云乎哟这github上复制地址即可) 3.报错:git p ...
- 如何向Linux内核提交代码,华人教授向 Linux 内核提交含 Bug 代码,Linux 管理员直接拉黑整所大学!...
技术编辑:小魔丨发自 思否编辑部公众号:SegmentFault Linux 内核是目前最大的软件项目之一,拥有 2800 万行代码.世界各地的贡献者每天向 Linux 内核管理员提交大量 patch ...
最新文章
- 给jar包进行数字签名(2014-06-28记)
- luogu p4767 邮局
- 南方s730手簿说明书_最新S730手簿及3.0简易操作82
- 二层交换机、三层交换机和路由器的基本工作原理和三者之间的主要区别
- 基准软件测试原理,基准测试
- 波利亚对教师日常工作的看法:〈教师十诫〉
- 牛!阿里云位居中国金融云市场第一
- docker nginx:1.21.4
- vue根据指令动态改变title名字
- 寻找新冠“解药”:在 10^60 化合物分子空间,他们用 AI 挖掘潜在药物
- [JDK8] Lambda
- 厌倦 VMware,试试更轻量级的虚拟机!
- Jekyll搭建lanmps.com站点
- 解决Iframe嵌入帆软BI系统后,Chrome升级后跨域出现登录界面,Cookie写入不成功。解决办法
- 计算机继电保护书籍,计算机继电保护的发展
- 松花江等三流域禁渔效果不理想 跨界水域成管理盲区
- ks检验正态分布结果_看SPSS如何检验数据是否服从正态分布
- 【空间单细胞组学】第2期:联合单细胞和bulk转录组鉴定了结直肠癌中两种上皮肿瘤细胞状态,并完善了CMS分型
- firewalld 规则配置
- 网页版python编辑器-史上超强 Python 编辑器,竟然是张网页?!
热门文章
- 灵活越障、花样空翻,腾讯轮腿式机器人亮相机器人顶会 ICRA
- 无代码的时代真的来了吗?
- 学会这21条,你离Vim大神就不远了
- 开发者,什么是你真正关心的问题?| AI ProCon 2019
- TIOBE 5 月编程语言排行榜:Python、C++竞争白热化,Objective-C已沦为小众语言
- 特斯拉终于要“国产”了!
- 专访 | 微软首席数据科学家谢梁:从经济学博士到爬坑机器学习,这十年我都经历了啥?
- List复制:深拷贝和浅拷贝用法及区别
- 为什么 Linux 需要 Swapping
- SpringBoot 2.3 新特性之优雅停机,这波操作太秀了!