Git使用规范

[TOC]

工作流指南

分支分类

  • 历史分支
    master: 存储了正式发布的历史,为主分支(保护分支),不能直接在master上进行修改代码和提交;
    develop:作为功能的集成分支,开发完成需要提交测试的功能合并到该分支;
  • 功能分支
    feature: 大家根据不同需求创建独立的功能分支,开发完成后合并到develop分支;
  • 发布分支
    release: 发布分支,主要用于测试或修复bug。
  • 维护分支
    hotfix: 为bug修复分支,需要根据实际情况对已发布的版本进行漏洞修复,必须从master拉取;

流程图解

image.png

命名规范

分支命名

功能分支: featrue/功能名称
发布分支:release/版本号-功能名称-发布日期
维护分支:hotfix/版本号-问题概述或issueid-日期 (最好使用issue建立问题描述?)
例如: release/转投优化-20181111

常见问题

分支管理策略

1. develop为集成开发分支
 提交规则: 
 自己分支自测完毕;
 review通过再合并;
2. 本地分支管理
本地分支必须从**线上版本节点**checkout();
本地分支要做到勤提交,分小功能提交;
一个功能点一个分支(自己控制),至少保证保留两个分支:  新版本分支、优化分支;
本地分支merge到develop分支时,必须先merge develop到本地分支,自测通过再提交;
3. 注意事项
开发者相同版本尽量不要修改相同功能,提前划分或协商清楚;
如果修改代码涉及多人功能,提交完毕请及时告知相关人员;
开发者每天更新develop分支内容到本地分支,避免大规模merge; 
fixbug分支修改测试完,立即合并到develop上! 

提交规范

Commit

Commit message一般包括三部分:Header、Body和Footer。
Header
type(scope):subject

  • type:用于说明commit的类别,规定为如下几种
    feature:新增功能;
    fix:修复bug;
    docs:修改文档;
    refactor:代码重构,未新增任何功能和修复任何bug;
    build:改变构建流程,新增依赖库、工具等(例如webpack修改);
    style:仅仅修改了空格、缩进等,不改变代码逻辑;
    perf:改善性能和体现的修改;
    chore:非src和test的修改;
    test:测试用例的修改;
    ci:自动化流程配置修改;
    revert:回滚到上一个版本;
  • scope:【可选】用于说明commit的影响范围
  • subject:commit的简要说明,尽量简短

Body
对本次commit的详细描述,可分多行

Footer
不兼容变动:需要描述相关信息
关闭指定Issue:输入Issue信息

Merge

代码合并、master分支操作,请在gitlab 提交 merge request,负责人进行代码review后,才能同意合并操作。

Tag(Version)

采用三段式,v版本.里程碑.序号,如v1.2.1

  • 架构升级或架构重大调整,修改第2位
  • 新功能上线或者模块大的调整,修改第2位
  • bug修复上线,修改第3位

参考文档:http://www.crom.cn/topics/338

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

推荐阅读更多精彩内容

  • 一、user.name 配置 Git 的 user.name配置一定要使用自己的中文名称。命令行操作方式如下: 二...
    霜序五阅读 801评论 0 0
  • 多种多样的工作流使得在项目中实施Git时变得难以选择。这份教程提供了一个出发点,调查企业团队最常见的Git工作流。...
    JSErik阅读 4,403评论 2 8
  • 1.git的安装 1.1 在Windows上安装Git msysgit是Windows版的Git,从https:/...
    落魂灬阅读 12,663评论 4 54
  • Git常用语法 [TOC] Git简介 描述 ​ Git(读音为/gɪt/。)是一个开源的分布式版本控制系统,...
    君惜丶阅读 3,511评论 0 13
  • 今天,终于下定决心,去医院做胃镜,胃子经常消化不良,还会胀气,最主要是隐隐作痛,五脏六腑的痛和外伤完全不一样,外伤...
    谢谋淦阅读 8,016评论 1 8