zoukankan      html  css  js  c++  java
  • Git 分支开发规范

    image

    分支管理

    分支命名

    master 分支

    • master 为主分支,也是用于部署生产环境的分支,确保master分支稳定性
    • master 分支一般由develop以及hotfix分支合并,任何时间都不能直接修改代码

    develop 分支

    • develop 为开发分支,始终保持最新完成以及bug修复后的代码
    • 一般开发的新功能时,feature分支都是基于develop分支下创建的

    feature 分支

    • 开发新功能时,以develop为基础创建feature分支
    • 分支命名: feature/ 开头的为特性分支, 命名规则: feature/user_module、 feature/cart_module

    release分支

    • release 为预上线分支,发布提测阶段,会release分支代码为基准提测
    当有一组feature开发完成,首先会合并到develop分支,进入提测时,会创建release分支。
    如果测试过程中若存在bug需要修复,则直接由开发者在release分支修复并提交。
    当测试完成之后,合并release分支到master和develop分支,此时master为最新代码,用作上线。
    复制代码

    hotfix 分支

    • 分支命名: hotfix/ 开头的为修复分支,它的命名规则与 feature 分支类似
    • 线上出现紧急问题时,需要及时修复,以master分支为基线,创建hotfix分支,修复完成后,需要合并到master分支和develop分支

    常见任务

    增加新功能

    (dev)$: git checkout -b feature/xxx            # 从dev建立特性分支
    (feature/xxx)$: blabla                         # 开发
    (feature/xxx)$: git add xxx
    (feature/xxx)$: git commit -m 'commit comment'
    (dev)$: git merge feature/xxx --no-ff          # 把特性分支合并到dev
    复制代码

    修复紧急bug

    (master)$: git checkout -b hotfix/xxx         # 从master建立hotfix分支
    (hotfix/xxx)$: blabla                         # 开发
    (hotfix/xxx)$: git add xxx
    (hotfix/xxx)$: git commit -m 'commit comment'
    (master)$: git merge hotfix/xxx --no-ff       # 把hotfix分支合并到master,并上线到生产环境
    (dev)$: git merge hotfix/xxx --no-ff          # 把hotfix分支合并到dev,同步代码
    复制代码

    测试环境代码

    (release)$: git merge dev --no-ff             # 把dev分支合并到release,然后在测试环境拉取并测试
    复制代码

    生产环境上线

    (master)$: git merge testing --no-ff          # 把testing测试好的代码合并到master,运维人员操作
    (master)$: git tag -a v0.1 -m '部署包版本名'  #给版本命名,打Tag
    复制代码
    image

    日志规范

    在一个团队协作的项目中,开发人员需要经常提交一些代码去修复bug或者实现新的feature。而项目中的文件和实现什么功能、解决什么问题都会渐渐淡忘,最后需要浪费时间去阅读代码。但是好的日志规范commit messages编写有帮助到我们,它也反映了一个开发人员是否是良好的协作者。

    编写良好的Commit messages可以达到3个重要的目的:

    • 加快review的流程
    • 帮助我们编写良好的版本发布日志
    • 让之后的维护者了解代码里出现特定变化和feature被添加的原因

    目前,社区有多种 Commit message 的写法规范。来自Angular 规范是目前使用最广的写法,比较合理和系统化。如下图:

    image

    Commit messages的基本语法

    当前业界应用的比较广泛的是 Angular Git Commit Guidelines

    具体格式为:

    <type>: <subject>
    <BLANK LINE>
    <body>
    <BLANK LINE>
    <footer>
    复制代码
    • type: 本次 commit 的类型,诸如 bugfix docs style 等
    • scope: 本次 commit 波及的范围
    • subject: 简明扼要的阐述下本次 commit 的主旨,在原文中特意强调了几点 1. 使用祈使句,是不是很熟悉又陌生的一个词,来传送门在此 祈使句 2. 首字母不要大写 3. 结尾无需添加标点
    • body: 同样使用祈使句,在主体内容中我们需要把本次 commit 详细的描述一下,比如此次变更的动机,如需换行,则使用 |
    • footer: 描述下与之关联的 issue 或 break change,详见案例

    Type的类别说明:

    • feat: 添加新特性
    • fix: 修复bug
    • docs: 仅仅修改了文档
    • style: 仅仅修改了空格、格式缩进、都好等等,不改变代码逻辑
    • refactor: 代码重构,没有加新功能或者修复bug
    • perf: 增加代码进行性能测试
    • test: 增加测试用例
    • chore: 改变构建流程、或者增加依赖库、工具等

    Commit messages格式要求

    # 标题行:50个字符以内,描述主要变更内容
    #
    # 主体内容:更详细的说明文本,建议72个字符以内。 需要描述的信息包括:
    #
    # * 为什么这个变更是必须的? 它可能是用来修复一个bug,增加一个feature,提升性能、可靠性、稳定性等等
    # * 他如何解决这个问题? 具体描述解决问题的步骤
    # * 是否存在副作用、风险? 
    #
    # 如果需要的化可以添加一个链接到issue地址或者其它文档
    复制代码

    参考链接

     


    作者:VincentSea
    链接:https://juejin.im/post/5b4328bbf265da0fa21a6820
    来源:掘金
    著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

    Git 分支命名规范
    分支: 命名: 说明:

    主分支 master 主分支,所有提供给用户使用的正式版本,都在这个主分支上发布
    开发分支 dev 开发分支,永远是功能最新最全的分支
    功能分支 feature-* 新功能分支,某个功能点正在开发阶段
    发布版本 release-* 发布定期要上线的功能
    修复分支 bug-* 修复线上代码的 bug

    主分支 Master
    首先,代码库应该有一个、且仅有一个主分支。所有提供给用户使用的正式版本,都在这个主分支上发布。

    Git主分支的名字,默认叫做 Master 。它是自动建立的,版本库初始化以后,默认就是在主分支在进行开发。

    开发分支 Dev
    主分支只用来分布重大版本,日常开发应该在另一条分支上完成。我们把开发用的分支,叫做 Dev
    这个分支可以用来生成代码的最新隔夜版本(nightly)。如果想正式对外发布,就在 Master 分支上,对 Dev 分支进行”合并”(merge)。

    Git创建 Dev 分支的命令:

    git checkout -b dev master

    将 Dev 分支发布到 Master 分支的命令:
    切换到 Master 分支
    git checkout master

    对 Dev 分支进行合并
    git merge –no–ff dev

    这里稍微解释一下,上一条命令的–no–ff参数是什么意思。默认情况下,Git执行”快进式合并”(fast-farward merge),会直接将 Master 分支指向 Dev 分支。
    使用–no–ff参数后,会执行正常合并,在 Master 分支上生成一个新节点。为了保证版本演进的清晰,我们希望采用这种做法。

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

    创建一个功能分支:

    git checkout -b feature-x dev

    开发完成后,将功能分支合并到dev 分支:
    git checkout dev
    git merge –no-ff feature-x

    删除feature分支:
    git branch -d feature-x

    预发布分支 Release
    第二种是预发布分支,它是指发布正式版本之前(即合并到 Master 分支之前),我们可能需要有一个预发布的版本进行测试。
    预发布分支是从 Dev 分支上面分出来的,预发布结束以后,必须合并进 Dev 和 Master 分支。它的命名,可以采用release- * 的形式。

    创建一个预发布分支:

    git checkout -b release-1.2 dev

    确认没有问题后,合并到master分支:
    git checkout master
    git merge –no-ff release-1.2

    对合并生成的新节点,做一个标签:
    git tag -a 1.2

    再合并到dev 分支:
    git checkout dev
    git merge –no-ff release-1.2

    最后,删除预发布分支:
    git branch -d release-1.2

    修补分支 Bug
    最后一种是修补bug分支。软件正式发布以后,难免会出现bug。这时就需要创建一个分支,进行bug修补。
    修补bug分支是从 Master 分支上面分出来的。修补结束以后,再合并进 Master 和 Dev 分支。它的命名,可以采用fixbug- * 的形式。

    创建一个修补bug分支:

    git checkout -b fixbug-0.1 master

    修补结束后,合并到master分支:
    git checkout master
    git merge –no-ff fixbug-0.1
    git tag -a 0.1.1

    再合并到dev 分支:
    git checkout dev
    git merge –no-ff fixbug-0.1

    最后,删除”修补bug分支”:
    git branch -d fixbug-0.1

    git tag usage
    # 添加
    git tag -a V0.1.110811 -m"基本部署完成,有BUG待做"

    #删除
    git tag -d V0.1.110811

    #推送到远程
    git push origin V0.1.110811

    git push –tags

    ---------------------
    作者:扯文艺的猿
    来源:CSDN
    原文:https://blog.csdn.net/qq_33858250/article/details/81047883
    版权声明:本文为博主原创文章,转载请附上博文链接!

  • 相关阅读:
    libevent的问题
    mysql homedir迁移
    mysql海量数据的优化
    Spark(Hive) SQL中UDF的使用(Python)【转】
    Spark SQL inferSchema实现原理探微(Python)【转】
    Spark SQL利器:cacheTable/uncacheTable【转】
    Spark使用CombineTextInputFormat缓解小文件过多导致Task数目过多的问题【转】
    ExecutorService-10个要诀和技巧【转】
    漫游Kafka之过期数据清理【转】
    kafka多线程消费及处理和手动提交处理方案设计[转]
  • 原文地址:https://www.cnblogs.com/lujiangping/p/10910558.html
Copyright © 2011-2022 走看看