大厂 Git 提交规范

走四方
2020-02-08

在项目中引入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。

关注微信公众号: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.jsonecho 'module.exports = {extends: #34;@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 选择改动类型 ()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进行格式校验,默认规定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暂不使用。

# 主要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。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_ID
fix #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

分享
版权声明:部分图文分享自互联网,如有侵权请联系:邮箱:163828@qq.com ,电话: 13302969796
2485022

单反摄影RAW格式拍摄揭秘图

我们在使用RAW格式拍摄时应该注意些什么?相信有不少读者都曾经尝试过使用RAW格式拍摄。JPEG格式是我们手中大部分相机的默认选择,尽管它非常方便...
走四方
2013-04-16 攻略

摄影单反相机全幅和半幅的区别

...:每种画幅都有其优点和缺点,每种格式都有各自适合的拍摄类型。此外,所有型号的相机都能拍摄出优秀的照片,即使是手机,也可以登上世界各地...
走四方
2017-07-07 攻略

爱,其实可以很简单

...自己?或许门当户对早已成为固定的格式。又能有多少人能在茫茫人海中找到自己的真爱?凑合着过或许已成为当代的一种生活状态。社会越来越发达...
丫头
2005-06-13 攻略

上海自己办理申根签证攻略

...职证明,我的单位有直接英文版固定格式,只要把清单中需要列明的内容告诉单位,让他们开就行了;如果你的单位没有模板,我这里提供一个,你单...
走四方
2018-09-28 攻略

我为什么摄影?世界著名摄影师语录

...用莱卡相机。这是一个更加私人化的工具。有了一个莱卡,你可以拥有你自己的风格,就好像你自己的笔迹一样。(杰罗·费切海姆,莱卡相机公司新闻...
走四方
2010-08-25 攻略

11月26日-27日富阳龙门山骑车+登杏梅尖+露营3合1活动!(因领队生病取消)

...及村民家停车费) 报名方式:跟贴以下格式或者电话报名或者QQ报名. (昵称/性别/装备是否齐全/联系电话/备注说明) (联系人:阿猫 电话:0571-85962779 QQ:330282...
阿猫
2005-11-16 攻略

无人机航拍入门手册专业摄影师带你飞

...用M档,并在低iso下进行拍摄。使用RAW格式进行拍摄对于摄影师,这一点勿需强调,RAW格式的可后期空间远超压缩的JPG格式,虽然无人机的RAW格式比起专...
走四方
2020-03-18 攻略

杭州公共自行车骑游完全攻略

...可通租通还,是一种绿色环保的交通工具。发展杭州公共自行车系统体系,构建公共交通与自行车换乘(B+R)及停车换乘(P+R)组合交通模式,是延伸...
走四方
2010-06-21 攻略
周边约伴