git workflow 规范

[TOC]

git workflow 规范

概要说明

分支管理和开发流程

  • 基本分支: master、develop、release/xxx、hotfix/xxx、feature/dev_xxx

  • master/release 分支,用来上线,打tag

  • 从 master 分支拉一个 develop 分支,用来开发演进,合并代码,最终会 merge 到 master 上

  • 从 develop 拉一个 feature/dev_xxx 分支,相关开发需求都提交到 dev_xxx 上,开发完了之后,merge 到 develop 部署测试环境

    • dev_xxx 分支合并到 develop 上之后删除 dev_xxx 分支
    • dev_xxx 分支一般都是临时功能开发用,合并后就没有保留的必要了
  • develop 分支开发完了以后,基于 develop 分支开一个 release/$version 的分支,部署测试环境验证ok后,将 release/$version 合并到 master验证一下,然后打 tag 上线

其他说明:

  • master 分支是最稳定的,在 develop 分支开发稳定后,开一个 release 分支后 merge 到 master 上打tag
  • dev_xxx 是功能开发分支,单人协作的时候,一般 merge 就可以。 如果是多人协作,那么一般自己本地的分支上开发提交,但是不 push 到远程,但是每次提交都 rebase 一下远程的 dev_xxx 分支。两个好处:
    • git log 的线会好看很多,少很多,看起来更方便
    • 冲突的概率会少很多,rebase 的时候,也不至于把自己的 commit 穿插到别人中,这样自己之前的 commit 在 rebase 后就是一个新的 commit 时间线

基准规范

基本分支规范

  • 首先基于 master 分支创建 develop 分支
  • 然后在 develop 分支基础上开一个 feature/xxx 的分支用来做开发
  • 开发完新特性后 merge 到 develop;并且同时删除 feature/xxx
  • develop 开发完了之后,基于 develop 创建一个 release/$version 支;用来 部署到 dev、pre 环境做测试
  • 测试 ok 之后,merge 到 master ,然后打 tag 上线

hotfix 规范

  • 基于之前release/xxx 检出新的 hotfix/xxx 分支,然后修复验证后合并到 er 和 develop 分支
  • 然后基于 master 再打 tag 上线

代码提交

  • 提交的信息,全部采用英文
  • 通过 commitizen 工具来提交(git cz 代替 git commit)
  • 通过 standard-version 做版本发布和自动生成 Changelog

代码 code review

  • feature/xxx 需要合并到 develop 的时候,通过 gitlab 创建一个 merge request ,然后指定其他同时或者上级领导,进行代码合并

  • feature/xxx,要求尽可能少的代码提交,当一个小的功能完备后就需要 MR。

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

推荐阅读更多精彩内容