Git(三)代码提交规范

本文介绍前端框架Angular提倡的 Git Commit Message 规范。


<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

每次提交包含消息头header、消息体body和消息尾footer,其中消息头内容必须。
每次提交信息不超过100个字符。

1. 消息头

消息头格式指定为提交类型type、作用域scope和主题subject

1.1 提交类型

  • build:修改构建系统或者外部依赖项
  • ci:修改 CI 配置文件或脚本
  • docs:修改文档
  • feat:增加新特性
  • fix:修复 Bug
  • pref:性能优化
  • refactor:代码重构
  • style:代码风格、代码规范修改
  • test:测试代码修改
  • revert:撤销上一次的 commit 提交
  • chore:构建过程或辅助工具变动

1.2 作用域

说明改动的范围。

1.3 主题

对本次修改的简单描述,注意以下原则:

  • 使用命令式,现在时态:改变,不是已改变,也不是改变了
  • 不要大写首字母
  • 不在末尾添加句号

2. 消息体

和主题设置类似,使用命令式、现在时态,应该包含修改的动机以及和之前行为的对比。

3. 消息尾

3.1 重大变化

所有重大的更改应以单词BREAKING CHANGE:跟上空格或两个换行符开头,在消息尾的开头以区块的方式声明。剩下的提交信息是对改动的描述,理由和迁移说明。

3.2 关闭问题

已关闭的问题应在消息尾中单独一行列出,并以Closes关键字作为前缀,如:Closes #XXX,或关闭多个问题:Closes #XXX, #XXX, #XXX

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

推荐阅读更多精彩内容

  • Git代码提交规范 前言 为什么要注重代码提交规范? 在团队协作开发时,每个人提交代码时都会写 commit me...
    keyuan0214阅读 5,293评论 0 3
  • 一、代码提交规范化的目的 为了部门提交代码信息格式规范化 为了更好的追溯代码、筛选 为了更加快速的定位提交代码所涉...
    RmondJone阅读 1,026评论 0 1
  • 代码提交规范(试用) 参考 参考百度 echarts 的更新标准。 组成 提交代码的注释由三部分组成:序号、标志、...
    果酱风阅读 603评论 0 1
  • AngularJS在github上的提交记录被业内大多数开发人员认可,逐渐被广泛引用。 1、提交格式 type (...
    听书先生阅读 2,303评论 0 24
  • 1.简介 commitizen是git提交信息的一种消息模式,同时也是规范我们git提交记录,用git cz代替g...
    web潇潇阅读 777评论 0 0