别再乱提交代码了,看下大厂 Git 提交规范是怎么做的!
来自丨掘金,
作者丨人人贷大前端技术中心
链接:
https://juejin.im/post/5d0b3f8c6fb9a07ec07fc5d0
git是现在市面上最流行的版本控制工具,书写良好的commit message能大大提高代码维护的效率。但是在日常开发中由于缺少对于commit message的约束,导致填写内容随意、质量参差不齐,可读性低亦难以维护。在项目中引入commit message规范已是迫在眉睫。
用什么规范?
现在市面上比较流行的方案是约定式提交规范
(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-changelog
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
安装完毕后,可直接使用git cz
来取代git commit
。
全局模式下,需要 ~/.czrc
配置文件, 为commitizen
指定Adapter
。
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.jsonecho '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
每一部分的填写规则。
1. type
type
为必填项,用于指定commit的类型,约定了feat
、fix
两个主要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的改动必须指明该项,类似版本升级、接口参数减少、接口删除、迁移等。
5. affect issues
affect issues
指明是否影响了某个问题。例如我们使用jira时,我们在commit message
中可以填写其影响的JIRA_ID
,若要开启该功能需要先打通jira
与gitlab
。参考文档:docs.gitlab.com/ee/user/pro…
填写方式例如:
re #JIRA_ID
fix #JIRA_ID
示例
完整的commit message示例
相应的git log
扩展阅读
1. conventional commits: 必读
介绍约定式提交标准(https://www.conventionalcommits.org/zh/v1.0.0-beta.4/ )。
2. Angular规范 必读
介绍Angular标准每个部分该写什么、该怎么写(https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md)。
3. @commitlint/config-conventional 必读
介绍commitlint的校验规则config-conventional,以及一些常见passes/fails情况。(https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum )
学习交流
关注公众号【前端宇宙】,每日获取好文推荐
添加微信号 ,入群交流
“在看和转发”就是最大的支持
别再乱提交代码了,看下大厂 Git 提交规范是怎么做的!相关推荐
- 别乱提交代码了,看下大厂 Git 提交规范是怎么做的!
Git是现在市面上最流行的版本控制工具,书写良好的commit message能大大提高代码维护的效率. 但是在日常开发中由于缺少对commit message的约束,导致填写内容随意.质量参差不齐, ...
- idea怎么提交到dev分支_IDEA设置git提交分支
这篇随笔包含几个点 1.如何设置默认提交远端分支 2.如何切换本地/远端分支 3.无法切换远端分支报错 最近代码重新Clone下来,改完提交代码的时候,总会默认提交到master分支上,并非自己的开发 ...
- 腾讯万字Code Review规范出炉!别再乱写代码了
本文经公众号:腾讯技术工程(ID:Tencent_TEG)授权转载,如需转载请联系出处. 作者:cheaterlin,腾讯 PCG 后台开发工程师 前言 作为公司代码委员会 golang 分会的理事, ...
- 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 我是一个全职的开源开发人员,或者,我喜欢称呼它为
- 别再乱搞了,快看优秀的代码是如何分层的!
作者:咖啡拿铁 链接:https://juejin.cn/post/6844903636334542856 1.背景 说起应用分层,大部分人都会认为这个不是很简单嘛 就controller,servi ...
- eclipse git提交代码_来看看大厂的Git提交规范,千万别乱提交代码哦...
点击上方"小黄鸭编程社区",选择"星标" 作者:人人贷大前端技术中心来源:https://urlify.cn/3a6NNb git是现在市面上最流行的版本控制工 ...
最新文章
- 今晚8点开播 | 思必驰NLP大牛带你系统学习启发式对话
- Sparkle: a free framework to automatically check for updates
- 375. Guess Number Higher or Lower II
- RabbitMQ整合SpringBoot(web)
- 【转】ubuntu16.04安装配置tftp服务
- 架构师需要懂的环境配置标准化
- auto.js实现微信双向删除好友功能(检测僵尸粉)
- 详解Spring AOP原理
- ps怎么转为html和css,一个登录界面的PS设计和HTML/CSS实现
- 使用WDF开发驱动程序
- 零跑股价纳入港股通,是被低估了的新势力
- HSSF、XSSF、SXSSF、对Excel的区别,以及对应不同后缀名Excel(xls,xlsx)的使用
- MVC下压缩输入的HTML内容
- unity制作手机h5小游戏,发布webgl后我的修改
- 和monkey的相处日记
- 回归预测 | MATLAB实现GWO-LSTM灰狼算法优化长短期记忆神经网络多输入单输出回归预测
- 华为 dis ip routing-table怎么看?
- 【论文阅读笔记】MFRDet:A single-shot multi-level feature reused neural network for object detection
- Visual Question Answering with Textual Representations for Images 论文笔记
- 2022年蓝牙耳机品牌推荐,三八女神节无线蓝牙耳机礼物推荐
热门文章
- 三国志战略版:当锋无法破防的司马盾
- python gtk_python-gtk学习笔记
- 思科FTP服务器如何传输文件,与FXP配置示例的ASA文件传输
- 怎么注册自定义域名Email.cn邮箱?
- 玩转Dokuwiki
- 怎么修改照片大小?一键快速修改图片宽高尺寸的方法
- ios 拍照上传到服务器_iOS 上传图片到服务器
- Pyinstaller打包
- pacman 查询_pacman
- java学习网络编程遇到异常java.net.SocketException:Software caused connection abort: socket write error