Git提交规范

目录:

  1. 提交操作规范
  2. 提交说明规范
  3. Angular提交说明规范

提交操作规范

为了保持分支提交历史的清晰、独立,在提交更改时,我们应做到:

  • 每一个提交都应该是一个完整、独立的变更单元;
  • 撰写符合提交说明规范 的提交说明信息;
  • 对于修复错别字、添加遗漏的更改等等之类的提交应与对应的提交合并,不应为其创建单独的提交;

多个提交合并成一个的各种方法请看Git中合并多个提交的各种方法

提交说明规范

Git 每次提交代码,都必须要写 提交说明; Git 对 提交说明 的格式是没有限制的,你想怎么写就怎么写,如下:

杂乱的提交说明

但是,类似这种没有格式的提交说明有以下缺点:

  • 不能很快分辨出提交的代码是增加了新功能、还是修复了bug、还只是更新了文档等等;
  • 不能有效地过滤某一类提交,比如:只想查看修复bug类的提交;
  • 不能根据需要过滤并导出提交信息,作为变更日志:比如,应用的升级的新功能说明、问题修复说明等等;

为了 方便 查看、过滤 提交说明,我需要将提交说明格式化、规范化;目前,有多种 提交说明 的写法规范。但我推荐 Angular提交说明规范,这是目前使用最广的写法,比较合理和系统化,并且有配套的工具。

关于 Angular提交说明规范 的详细文章请见:

下面是我对 Angular提交说明规范 一个汇总描述;

Angular提交说明规范

Angular提交说明的格式如下:

  • [] 表示可选的;
  • <> 表示必须的;
<Type>[(Scope)]:<Subject>
<空一行>
[Body]
<空一行>
<Footer>
  • 只有 TypeSubject 是必须的,其它的都是可选的;

  • 提交说明包括三个部分:Header(第一行)、Body(可选) 和 Footer(可选),用空行分隔;其中 Body、Footer 都是可选的,可以省略;

  • 任何一行都不得超过72、100个字符;这是为了避免自动换行影响美观

  • Header:只占第一行,包括三个字段:Type(必需)、Scope(可选)和 Subject(必需);

    • Type:必需;用于说明提交的类别,只允许使用下面7个标识:

      • feat:新功能(feature)
      • fix:修补bug
      • doc:文档(documentation),(很多规范里使用的是复数 docs,但我更建议使用 doc)
      • style: 格式(不影响代码运行的变动)
      • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
      • test:增加测试
      • chore:构建过程或辅助工具的变动

      如果type为feat和fix,则该 commit 将肯定出现在 Change log 之中。其他情况(doc、chore、style、refactor、test)由你决定,要不要放入 Change log,建议是不要。
      提示: 为了醒目,也可以为每个 Type 分别指定一个 Emoji 表情,将其放在 Type 前面 或 后面;

    • Scope:可选;用于说明提交的影响范围,比如数据层、控制层、视图层等等,视项目不同而不同。

    • Subject:提交目的 的简短描述;要求如下:

      • 不超过50个字符。
      • 以动词开头,使用第一人称现在时,比如 change,而不是 changed 或 changes
      • 第一个字母小写
      • 结尾不加句号 .
  • Body:对本次提交的详细描述,

    • 可以分成多行。
    • 使用第一人称现在时,比如使用change而不是changed或changes。
    • 应该说明代码变动的动机,以及与以前行为的对比。
  • Footer:Footer 部分只用于两种情况。

    1. 不兼容变动:如果当前代码与上一个版本不兼容,则 Footer 部分以 BREAKING CHANGE 开头,后面是对变动的描述、以及变动理由和迁移方法。
    2. 关闭 Issue:如果当前 提交 针对某个 issue 的,那么可以在 Footer 部分用 Closes #234 关闭这个 issue ;也可以用 Closes #123, #245, #992 一次关闭多个 issue ;
  • 特殊情况: 如果当前 提交 用于撤销以前的 提交,则:

    • Header 必须以 revert: 开头,后面跟着被撤销的提交的 Header。
    • Body 部分的格式是固定的,必须写成This reverts commit <hash>.,其中的 hash 是被撤销的 提交 的 SHA 标识符。
      如果当前提交 与 被撤销的 提交,在同一个发布(release)里面,那么它们都不会出现在 Change log 里面。如果两者在不同的发布,那么当前 commit,会出现在 Change log 的 Reverts 小标题下面。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容

  • git的规范和相关科普知识 git commit 的规范要求(参考Angular团队) message格式如下: ...
    达文西_Huong阅读 737评论 0 0
  • 完整参考实际项目中实践过后,感觉很实用,检索起来很方便。 1. 提交规范的必要性 Git每次提交代码,需要填写co...
    PaulLuv阅读 1,610评论 0 0
  • git 提交规范 前言 无规矩不成方圆,编程也一样。 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,...
    janlle阅读 401评论 0 1
  • Git 提交规范 制定一个 git commit 信息的提交规范是开发团队工作流必不可少的环节。试想一下,如果查看...
    十月里的男艺术家阅读 782评论 0 0
  • 良好的Commit Message有利于代码审查,能更快速查找变更记录,并且可以直接生成Change log。 在...
    云翼飞阅读 1,931评论 0 1