git commit message规范

1、背景

在使用git时,每次代码提交都需要写commit message作为git log以便于项目管理。
然而在日常的团队开发中,每个人的commit message千奇百怪,规范不一致,中英文混合使用等问题,会导致项目git log格式混乱、不便维护。因此,构建一份结构清晰、简洁优雅的commit message规范不仅有助于高效管理项目、降低维护成本,也方便团队成员之间review、提高研发效率。

2、commit message规范

<type>[(<scope>)]: <subject>

其中,<type> 和 <subject>是必填项,(<scope>)是选填项
下面对这三个模块详细阐述:

2.1 type

type用于声明本次代码提交的类型(英文,必填项),通常是在满足一个技术和业务域需求的条件下的团队约定的有限集合,便于成员统一共识,不宜太多导致类型太散、不便记忆,也不宜太少,无法有效区分。
从算法团队角度出发,将类型限定在如下集合:
feat:新功能特性。
fix:bug修复。
perf:功能优化,包括性能优化、体验优化等。
refactor:代码重构(大范围的代码结构重构,不涉及代码功能)
style:格式调整(小范围的代码格式调整,不涉及代码功能)
merge:代码分支合并
revert:代码版本回滚
test:测试代码变动
doc:文档变动

2.2 scope

scope用于声明本次代码提交的影响范围(建议英文,选填项),如Model层、Dao层、Service层、Controller层、View层等等。
如果涉及多个scope,可以置空或用*代替。

2.3 subject

subject用于声明本次代码提交的描述信息(建议中文,必填项)。
通常控制在50个字符内,且省略句末标点符号。

以上是一些基本的 commit message规范,项目的复杂性和业务域不同,可能会有不同的调整或补充,就以上规范,列举几个示例如下:

feat(Controller):商品属性识别接口开发
fix(Service):入参边界检查条件不足

参考文献

如何规范你的Git commit?

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 221,635评论 6 515
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,543评论 3 399
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 168,083评论 0 360
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,640评论 1 296
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,640评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,262评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,833评论 3 421
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,736评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,280评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,369评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,503评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,185评论 5 350
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,870评论 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,340评论 0 24
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,460评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,909评论 3 376
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,512评论 2 359