如何规范你的Git commit?

2020 年 9 月 09 日

如何规范你的Git commit?

背景

Git 每次提交代码都需要写 commit message,否则就不允许提交。一般来说,commit message 应该清晰明了,说明本次提交的目的,具体做了什么操作……但是在日常开发中,大家的 commit message 千奇百怪,中英文混合使用、fix bug 等各种笼统的 message 司空见怪,这就导致后续代码维护成本特别大,有时自己都不知道自己的 fix bug 修改的是什么问题。基于以上这些问题,我们希望通过某种方式来监控用户的 git commit message,让规范更好的服务于质量,提高大家的研发效率。

规范建设

规范梳理

初期我们在互联网上搜索了大量有关 git commit 规范的资料,但只有 Angular 规范是目前使用最广的写法,比较合理和系统化,并且有配套的工具(IDEA 就有插件支持这种写法)。最后综合阿里巴巴高德地图相关部门已有的规范总结出了一套 git commit 规范。

commit message 格式

复制代码
<type>(<scope>): <subject>

type(必须)

用于说明 git commit 的类别,只允许使用下面的标识。

feat:新功能(feature)。

fix/to:修复 bug,可以是 QA 发现的 BUG,也可以是研发自己发现的 BUG。

原文链接:【 https://www.infoq.cn/article/fVRAZhpYeLJg9jsyDdas 】。未经作者许可,禁止转载。

登录后可解锁全站优质内容

免费畅享技术公开课、顶尖技术团队访谈、一线互联网大厂技术实践

文章
视频
电子书
研究报告
立即登录
2020 年 9 月 09 日 10:00 3729

评论

发布
暂无评论
发现更多内容

使用Spring Boot和Docker构建微服务架构(三)

MaxHu

Docker 架构 容器 微服务 Spring Boot

配置国内的pip源以提高使用pip安装python软件包的速度

良少

Python pip

使用Spring Boot和Docker构建微服务架构(一)

MaxHu

Docker 架构 容器 微服务 Spring Boot

DDD 中的那些模式 — CQRS

Joshua

领域驱动设计 DDD 事件驱动 CQRS Event Driven

理解这八大优势,才算精通单元测试

陈琦

测试 单元测试

坚持ARTS(week-1)

王钰淇

ARTS 打卡计划

Jsp页面报错后如何找到提示信息中的_jsp.java文件

阡陌r

微信gif图片大小的规则

石云升

微信 GIF

zookeeper到nacos的迁移实践

小楼

架构 nacos

微软:正式发布针对 .NET Core的 Winform 设计器

Geek_Willie

.net 微软 Win .net core

Spring事务@Transactional底层原理

公众号:好奇心森林

spring 事务 hiber

快速入门 Nacos 作为配置中心操作

zhuoqianmingyue

nacos SpringBoot 2

玩转SpringBoot2.x之缓存对象

zhuoqianmingyue

redis springboot

Cassandra集群架构及算法剖析

老任物联网杂谈

大数据 分布式 Cassandra 时序数据库

爬虫框架Scrapy应用实践-淘宝保险频道数据抓取【1】-前期准备

hadesxiong

Python 爬虫 保险 Scrapy

产品周刊 | 第 16 期(20200524)

Herbert

产品 设计 产品经理 产品设计

足不出户“逛”银行,37家城商行、农商行手机银行App性能大比拼

BonreeAPM

APM App 评测 网银 银行

Java | @Override 不要再把它当成可有可无的了

YoungZY

Java 注解 Override annotation

ARTS第一周

困到清醒

ARTS 打卡计划 起跑

企业微信机器人在大型财务共享中心的应用实践

DT极客

后台定时统计任务太耗时如何优化一下

zhuoqianmingyue

线程池

代码刚提交暂存区,组长突然要我把新增代码 Commit另一分支怎么办?

zhuoqianmingyue

git

使用Spring Boot和Docker构建微服务架构(二)

MaxHu

Docker 架构 容器 微服务 Spring Boot

在线文档的开发难度与突破

Geek_Willie

分布式协同 SpreadJS 在线文档

思考:如何打造一个优秀的研发体系?

菜根老谭

研发管理 研发效能 研发体系

从零到部署:用 Vue 和 Express 实现迷你全栈电商应用(二)

图雀社区

node.js vue.js Vue

列个清单-《清单革命》

Jack Hong

20200518-20200524朋友圈思考汇总

罗小布

日常思考

Spring Cloud 和 Dubbo 哪个会被淘汰?

程序猿DD

Spring Cloud dubbo

是什么在背后支撑起“带货一哥”李佳琦?

BonreeAPM

负载均衡 APM 压测 秒杀 并发

我是程序员,我为自己代言,我相信程序改变世界,虽然少不了质疑和嘲笑

陆陆通通

编程 程序员 高薪 代码

如何规范你的Git commit?-InfoQ