Git规范

团队开发中,遵循一个合理、清晰的 Git 规范,是非常重要的。

否则,每个人都提交一堆杂乱无章的 commit 和 分支,项目很快就会变得难以协调和维护。

流程规范

  1. 拉取最新代码。开始开发前,首先确保自己的代码为最新。
  2. 新建分支。每次开发新功能,都应该新建一个单独的分支。
  3. 提交分支 commit,撰写提交信息。
  4. 与主分支同步。
  5. 合并 commit。分支开发完,可能有一堆的 commit,但是合并到主干的时候,往往希望只有一个(或最多两三个)commit,这样不仅清晰,也容易管理。
  6. 推送到远程仓库。
  7. 请求别人进行 code review,确认无误可以合并到 master。

分支规范

  • master 分支(主分支) 稳定版本

  • develop 分支(开发分支) 最新版本

  • release 分支(发布分支) 发布新版本

  • fixbug 分支(热修复分支) 修复线上 Bug

  • feature 分支(特性分支) 实现新特性

功能分支

它是为了开发某种特定功能,从 Develop 分支上面分出来的。

开发完成后,要再并入 Develop。

功能分支的名字,可以采用 feature-*的形式命名。

预发布分支

它是指发布正式版本之前(即合并到 Master 分支之前),我们可能需要有一个预发布的版本进行测试。

预发布分支是从 Develop 分支上面分出来的,预发布结束以后,必须合并进 Develop 和 Master 分支。

它的命名,可以采用 release-* 的形式。

修补 bug 分支

软件正式发布以后,难免会出现 bug。这时就需要创建一个分支,进行 bug 修补。

修补 bug 分支是从 Master 分支上面分出来的。

修补结束以后,再合并进 Master 和 Develop 分支

它的命名,可以采用 fixbug-* 的形式。

Commit message 规范

格式化的 Commit message,有几个好处。

  1. 提供更多的历史信息,方便快速浏览。
  2. 可以过滤某些 commit(比如文档改动),便于快速查找信息。
  3. 可以直接从 commit 生成 Change log。

格式

每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

Header

Header 部分只有一行,包括三个字段:type(必需)、scope(可选)和 subject(必需)。

type 用于说明 commit 的类别。

  • feature:新功能(feature)
  • fixbug:修补 bug
  • docs:文档(documentation)
  • refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
  • test:增加测试

scope 用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

subject 是 commit 目的的简短描述,不超过 50 个字符。

  • 以动词开头,使用第一人称现在时,比如 change,而不是 changed 或 changes
  • 第一个字母小写
  • 结尾不加句号(.)

Body

本次 commit 的详细描述,可以分成多行。

Footer

Footer 部分只用于两种情况。

不兼容变动:如果当前代码与上一个版本不兼容,则 Footer 部分以 BREAKING CHANGE 开头,后面是对变动的描述、以及变动理由和迁移方法。

关闭 Issue:如果当前 commit 针对某个 issue,那么可以在 Footer 部分关闭这个 issue 。也可以一次关闭多个 issue 。

Closes #123, #245, #992

参考资料

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