移动端git管理规范

一、GitFlow

Git的分支管理规范我们参考GitFlow, GitFlow是由荷兰程序员Vincent Driessen提出的Git管理规范(A successful Git branching model)。

二、GitFlow 常用分支

master

• 主分支 , 产品的功能全部实现后 , 最终在 master 分支对外发布
• 该分支为只读唯一分支 , 只能从其他分支(release/hotfix)合并 , 不能在此分支修改
• 所有在 master 分支的推送应该打标签做记录,方便追溯
• 例如 release 合并到 master , 或 hotfix 合并到 master

develop

• 主开发分支 , 基于 master 分支克隆
• 该分支为只读唯一分支 , 只能从其他分支合并
• feature 功能分支完成 , 合并到 develop
• 从 develop 创建 release 分支提测
• release/hotfix 分支上线完毕 , 合并到 develop 并推送

feature

• 功能开发分支 , 基于 develop 分支克隆 , 主要用于新需求新功能的开发,属于临时分支
• feature 分支可同时存在多个 , 用于团队中多个功能同时开发
• 功能开发完毕并测试完成后合到 develop 分支。合并后此分支删除(谁合并谁删除)

release

• 从 develop 分支克隆,属于临时分支
• 用于提交给测试人员进行功能测试 , 测试过程中发现的 BUG 在本分支进行修复 , 修复完成上线后合并
• 合并到 develop/master 分支并推送(完成功能) , 打 Tag
• 合并完成后此分支删除(谁合并谁删除)

hotfix

• Bugfix 补丁分支 , 基于 master 分支克隆 , 主要用于对线上的版本进行 BUG 修复,属于临时分支
• 修复完毕后合并到 master 分支并推送 , 打 Tag
【注意】如不对 bug 进行临时发版,不需要合并到 master 分支
• 合并到 develop 分支并推送
• 合并到 develop/master 后,此分支删除(谁合并谁删除)

三、主要工作流程

GitFlow 的工作主要工作流程如下


image.png

四、code review

code review 有条件的,可以采用Gerrit 、phabricator 等三方工具,他们会有一个中心仓库,方便code review,没条件的可以用gitlab自带的Merger request,在合并至develop时进行 code review

Commit Message规范

目前 AngularJS 在github上的提交规范是被业内很多人认可的,也被大家逐渐引用。同时针对这种提交格式也有成熟的工具,来根据commit的message记录自动生成Change Log内容。所以我们也采用同样的规范来进行约束。

AngularJS Git Commit Message规范 - Google Doc文档需翻墙。

  1. 格式:Commit Message包括三部分内容: header,body和footer。其中header是必须的,body和footer可以省略。
 <type>(<scope>): <subject>
 <BLANK LINE>
 <body>
 <BLANK LINE>
 <footer>
  1. header: header部分只有一行,包括三个字段type(必需)、scope(可选)和subject(必需)。
    *   type:用于说明commit的类别。
        *   feat: 新功能(feature)
        *   fix:修复bug
        *   update: 普通的内容修改
        *   docs:文档
        *   style:格式(不影响代码运行的变动)
        *   refactor:重构(即不是新增功能,也不是修改bug的代码变动)
        *   test:增加测试
        *   chore:构建过程或辅助工具
        *   scope:用于说明commit影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
        *   subject:commit目的的简短描述。
# 新功能
feat: 轻应用离线包管理
# 修复bug
fix: 修复下载的xmind类型文件,预览识别类型不正确的问题
# 文档更新
docs: 轻应用离线功能的文档更新
# 重构
refactor: 优化下载预览
# 增加测试
test``: 下载逻辑增加单元测试
# 自动化、脚本等
chore: 修改sonar扫描的配置信息
 ```
  1. body:对本次commit的详细描述,可以分成多行。

    More detailed explanatory text, if necessary. Wrap it to
    about 72 characters or so.
    Further paragraphs come after blank lines.

    - Bullet points are okay, too
    - Use a hanging indent
  1. footer:只用于以下两种情况

    • 如果当前代码与上一个版本不兼容,则footer部分以BREAKING CHANGE开头,后面是对变动的描述,以及变动理由和迁移方法。
      BREAKING CHANGE: isolate scope bindings definition has changed.
      To migrate the code follow the example below:

      Before:
      scope: {
               myAttr: attribute,
      }
      After:
      scope: {
      myAttr: @,
      }
      
      

    关闭Issue,如果当前commit是针对某个issue,那么可以在footer部分关闭这个issue。

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

推荐阅读更多精彩内容

  • Git 规范 所有使用了本规范的项目,必须严格规范操作,否则不予以合并代码、提测、打包上线等后续操作。 基本要求 ...
    zgsddzwj阅读 13,603评论 1 14
  • 分支说明和对应的操作 master分支 Git主分支的名字,默认叫做master。它是自动建立的,版本库初始化以后...
    米_8d62阅读 2,030评论 0 1
  • [TOC] Git 内部实现原理剖析[//www.greatytc.com/p/8154ac47d406...
    Whyn阅读 609评论 0 0
  • Git是一个十分优秀的版本控制工具,但仅仅依靠版本控制工具,还不能保证在多人协作的情况让项目的版本流转有条不紊,版...
    科研者阅读 2,464评论 0 7
  • 1 GIT,在技术层面上,绝对是一个无中心的分布式版本控制系统,但在管理层面上,我建议你保持一个中心版本库。 2 ...
    聂顺阅读 781评论 0 1