git提交后的代码在哪儿_别乱提交代码了,来围观下大厂的 Git 提交规范
作者:人人贷大前端技术中心
链接:https://juejin.im/post/5d0b3f8c6fb9a07ec07fc5d0
git是现在市面上最流行的版本控制工具,书写良好的commit message能大大提高代码维护的效率。但是在日常开发中由于缺少对于commit message的约束,导致填写内容随意、质量参差不齐,可读性低亦难以维护。在项目中引入commit message规范已是迫在眉睫。
0. 用什么规范?
现在市面上比较流行的方案是约定式提交规范
(Conventional Commits
),它受到了Angular提交准则
的启发,并在很大程度上以其为依据。约定式提交规范
是一种基于提交消息的轻量级约定。它提供了一组用于创建清晰的提交历史的简单规则;这使得编写基于规范的自动化工具变得更容易。这个约定与SemVer
相吻合,在提交信息中描述新特性、bug 修复和破坏性变更。它的 message 格式如下:
[可选的作用域]:
[可选的正文]
[可选的脚注]
1. Quick Start
1.1 全局安装commitizen & cz-conventional-changelog
commitizen
是一个撰写合格commit message
的工具,用于代替git commit
指令,而cz-conventional-changelog
适配器提供conventional-changelog[1]标准(约定式提交标准)。基于不同需求,也可以使用不同适配器。
npm install -g commitizen cz-conventional-changelogecho '{ "path": "cz-conventional-changelog" }' > ~/.czrc
安装完毕后,可直接使用git cz
来取代git commit
。
全局模式下,需要 ~/.czrc
配置文件, 为commitizen
指定Adapter
。
1.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
只能做格式规范,无法触及内容。对于内容质量的把控只能靠我们自己。
1.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" }}
1.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
2. Commit message 规范
针对团队目前使用的情况,我们讨论后拟定了commit message
每一部分的填写规则。
2.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
。
2.2 scope
scope
也为必填项,用于描述改动的范围,格式为项目名/模块名,例如:node-pc/common
rrd-h5/activity
,而we-sdk
不需指定模块名。如果一次commit修改多个模块,建议拆分成多次commit,以便更好追踪和维护。
2.3 body
body
填写详细描述,主要描述改动之前的情况
及修改动机
,对于小的修改不作要求,但是重大需求、更新等必须添加body来作说明。
2.4 break changes
break changes
指明是否产生了破坏性修改,涉及break changes的改动必须指明该项,类似版本升级、接口参数减少、接口删除、迁移等。
2.5 affect issues
affect issues
指明是否影响了某个问题。例如我们使用jira时,我们在commit message
中可以填写其影响的JIRA_ID
,若要开启该功能需要先打通jira
与gitlab
。参考文档:docs.gitlab.com/ee/user/pro…[2]
填写方式例如:
re #JIRA_IDfix #JIRA_ID
3. 示例
完整的commit message示例
![](/assets/blank.gif)
相应的git log
![](/assets/blank.gif)
4. 扩展阅读
conventional commits[3]必读
介绍约定式提交标准。
Angular规范[4]必读
介绍Angular标准每个部分该写什么、该怎么写。
@commitlint/config-conventional[5]必读
介绍commitlint的校验规则config-conventional,以及一些常见passes/fails情况。
参考资料
[1]
conventional-changelog: https://github.com/conventional-changelog/conventional-changelog
[2]
docs.gitlab.com/ee/user/pro…: https://docs.gitlab.com/ee/user/project/integrations/jira.html
[3]
conventional commits: https://www.conventionalcommits.org/zh/v1.0.0-beta.3/
[4]
Angular规范: https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines
[5]
@commitlint/config-conventional: https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum
推荐阅读
太赞了!《Python 黑魔法指南》终于面世了
Python炫技操作:花式导包的八种方法
VS Code 连接远程服务器运行 Jupyter Notebook
GitHub发布重磅更新:你电脑上的IDE可以删了?
求你了,别再使用 pprint 打印字典了
用上这 5 款神器后,你写的代码逼格瞬间爆表
长按下图 ➡ 关注博主
(按左边关注 Python, 按右边关注 Goalng)
git提交后的代码在哪儿_别乱提交代码了,来围观下大厂的 Git 提交规范相关推荐
- svn 项目提交后在服务器里面哪里,SVN如何实现工作代码提交后实时更新到测试服务器...
<SVN如何实现工作代码提交后实时更新到测试服务器>由会员分享,可在线阅读,更多相关<SVN如何实现工作代码提交后实时更新到测试服务器(21页珍藏版)>请在人人文库网上搜索. ...
- git统计每个人的代码行数_项目出了bug如何甩锅?使用这个Git工具帮你找到元凶...
公众号关注 "程序员遇见GitHub" 设为"星标",重磅干货,第一时间送达. 作为程序员,在职场当中经常遇到出现了问题需要定职定责的情况.比如某个系统出现了b ...
- git idea 本地历史版本回滚_如何为IDEA项目创建GitHub存储库和本地Git存储库
有几种方法可以使用IntelliJ IDEA来发布我们在GitHub上编写的代码.在此博客中,我们将介绍两种方法.第一个步骤是最快的一步,您可以在其中创建本地和远程存储库.第二种方法是多步骤,当您要为 ...
- 统计代码行数_推荐一波代码量、行数、提交量、作者等全维度统计神器
背景 代码各种维度的统计在有些时候是很重要的,这里总结一些常用的牛逼的代码统计工具,着重介绍了个人使用的 Statistic 插件.但是如果你是想统计团队维度的数据,推荐后面介绍的 git_stats ...
- python代码修复神器_一键 fxxk,代码修复神器拯救你
原标题:一键 fxxk,代码修复神器拯救你 作者 | 一一 出品 | AI科技大本营(ID: rgznai100) 在成为一个合格的开发者之前,大多数人一般都经历过被命令行反复"fuck&q ...
- python 代码转程序_精悍的Python代码段-转
1 文件处理 readlines() 和 writelines()方法可以讲列表元素依次写到文件中: file类本身没有提供复制方法,可以使用read()和write()方法模拟实现文件的拷贝,也可以 ...
- 低代码开发平台_什么是低代码和无代码开发平台?
低代码/无代码开发平台是一种可视化软件开发环境,允许公民开发人员拖放应用程序组件,将它们连接在一起并创建移动或Web应用程序.这种模块化方法使专业开发人员可以免除他们逐行编写代码的需要,从而更快地构建 ...
- python代码颜色搭配_修改Python IDLE代码配色及语法高亮主题
文章1 原出处:http://wangye.org/blog/archives/634/ 文章2 原出处:http://huacnlee.com/blog/share-someting-python- ...
- java打出的代码如何保存_如何使用java代码导出word
前言: 导出word的需求其实在日常工作中用到的地方还不少,于是想写一篇文章好好记录一下,在导出之前,需要了解一下关于浏览器如何处理servlet的后台数据.具体可以了解一下http通信下载行为在se ...
最新文章
- RabbitMQ:入门(三)——RabbitMQ用户管理、角色管理与权限管理
- 阿里云短信验证解决方案(java版)(redis存储)
- 【JavaScript】【PPT】继承的本质
- java左右三角_java打印一个顺序与倒序的杨辉三角,要求两个三角左右排列
- java静态变量,静态代码块,普通代码块,构造函数加载顺序
- 产业链人士:存储芯片平均售价有望在明年一季度停止下滑 随后趋于稳定
- SpringBoot中yml配置文件:定义list集合、数组及注意事项
- android-eclips中logcat不显示信息的问题解决
- 关于三角函数图像的思考
- 快速的mysql导入导出数据(load data和outfile)
- 模型描述的关系模式_图解各种管理模型大全--管理模型大全
- 求三点外接圆圆心公式
- 微信web版swoole聊天室之 MongoDB安装
- 抖音算法推荐机制详解(科普向)
- 【高等数学笔记】变限积分求导问题
- linux 文件大小单位显示
- 新拉下来的vue项目怎么跑起来?
- [升级][报错]zipimport.ZipImportError: can‘t decompress data; zlib not available
- 手机投屏电视html,oppor17手机投屏电视的详细操作步骤
- html站点根目录在哪里,html中的绝对路径URL和相对路径URL及子目录、父目录、根目录...
热门文章
- php $s=#039;kkk#039; if($s==0),之前收集到的PHP总结笔记
- 【Hexo】搭建自己的博客并到Github Pages
- Python面试基础题-2018-12-26
- BootStrap2学习日记8---表单
- [android] Serializable 和 Parcelable 区别
- 如何解决:Android中 Error generating final archive: Debug Certificate expired on 的错误
- 物理光学10 相干光与相干性
- MFC文档、视图类的基本功能和二者基本关系
- VC++中Depends工具的使用和DLL函数的动态调用方式示例
- 利用ajax技术 实现用户注册。