git 分支管理规范

分支命名

master 分支

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

develop 分支

        develop 为开发环境分支,始终保持最新完成以及bug修复后的代码,用于前后端联调。一般开发的新功能时,feature分支都是基于develop分支创建的。

feature 分支

        开发新功能时,以develop为基础创建feature分支。

        分支命名时以 feature/开头,后面可以加上开发的功能模块, 命名示例:feature/user_modulefeature/cart_module`

        主线开发分支:每个迭代只有一个主线开发分支,大部分功能在这个分支上开发

        命名规范: feature-${迭代发版日期}-${版本号},例如 feature-20220710-1.3.0

        支线开发分支:用于主线开发分支并行的支线功能开发,由于此类功能开发周期长,与主线功能相对独立,为避免开发过程对主线分支造成影响,单独拉出支线分支

        命名规范: 以主线开分支命称为前缀即可,例如 feature-20220710-1.3.0-springboot-upgrade,其中前缀feature-20220710-1.3.0 对应的主线开发分支名称

我们现在版本号:我们用产品Prd 定义的为准

test分支

        test为测试环境分支,外部用户无法访问,专门给测试人员使用,版本相对稳定。

release分支

        release 为预上线分支(预发布分支),UAT测试阶段使用。一般由 test 或 hotfix 分支合并,不建议直接在 release 分支上直接修改代码。

Uat 分支(同release)

        Uat 分支为交付验收分支,其实和release的作用一样

hotfix 分支

        线上出现紧急问题时,需要及时修复,以master分支为基线,创建hotfix分支。修复完成后,需要合并到 master 分支和 develop 分支(test/uat cherry pick 合并 同时保证问题再其他主线分支上修复)。

        分支命名以hotfix/ 开头的为修复分支,它的命名规则与 feature 分支类似。

分支与环境对应关系

在系统开发过程中常用的环境:

  • DEV 环境(Development environment):用于开发者调试使用

  • FAT环境(Feature Acceptance Test environment):功能验收测试环境,用于测试环境下的软件测试者测试使用

  • UAT环境 (User Acceptance Test environment):用户验收测试环境,用于生产环境下的软件测试者测试使用

  • PRO 环境(Production environment):生产环境

对应关系:

分支功能环境可访问合并人员
master主分支,稳定版本PRO运维人员管理
develop开发分支,最新版本DEV研发人员
feature开发分支,实现新特性研发人员
test测试分支,功能测试FAT测试人员管理
release(cat)预上线分支,发布新版本UAT测试人员、运维人员管理
hotfix紧急修复分支,修复线上bug运维人员管理

分支合并流程规范

        业界常见的两大主分支(master、develop)、三个辅助分支(feature、release、hotfix)的生命周期:

        以上生命周期仅作参考,不同开发团队可能有不同的规范,可自行灵活定义。

例如我们团队在开发时,至少需要保证以下流程:

  • develop 分支和 hotfix 分支,必须从 master 分支检出

  • 由 develop 分支合并到 test 分支

  • 功能测试无误后,由 test 分支合并到uat 分支

  • UAT测试通过后,从master 拉 release 分支将uat 和 新拉的 release中 , 线上验证没问题再 合并到 master分支

  • 对于工作量小的功能开发(工时小于1天),可以直接在devolop 分支进行开发,否则由 develop 分支检出 feature 分支进行开发,开发完后合并到develop 分支

具体操作流程:

        产品根据需求的优先级提前做好规划,确定每个迭代需要完成的需求,并规划好迭代的版本和评估大致的上线日期,基于产品规划的迭代,研发即可介入需求实现的设计和研发,在研发的过程中,Git需遵循如下流程

  • 研发组长基于develop分支创建feature类的分支,并将该分支推送到远程,分支名: feature-版本号;示例: feature-3.7.0

  • 研发同事将feature-3.7.0拉取到本地,然后在本地feature-3.7.0开发。

  • 研发完成个人任务,并自测通过后,即可将【本地】feature-3.7.0的分支推送到【远程】feature-3.7.0 ,并将feature分支合并到develop分支,把develop部署到开发联调环境中进行联调

  • 联调通过后,研发人员发起测试申请,转入测试阶段。测试人员把feature-3.7.0合并到test分支,然后test分支部署到测试环境进行测试

  • 测试过程中发现的bug,研发人员仍在feature-3.7.0上修复,修复完再通知测试人员(每次可多修复一些,减少部署测试环境的次数),测试人员再通过合并到test分支的方式部署到测试环境,如此反复

  • 测试结束后,测试人员将test分支合并到uat分支,uat分支部署到UAT环境进行产品验收 (这个可以按照具体要上uat的内容 按需发布)

  • 产品验收通过后,研发组长从master分支拉出相同版本号的release分支,示例: release-3.7.0,然后把UAT分支合并到release-3.7.0,由运维同事把release-3.7.0发到正式环境,开始线上验证

  • 线上验证通过后,研发组长将release-3.7.0合并到master,打tag,并删除相应的主线feature分支

  • 如果线上验证不通过,则运维直接把master分支部署到正式环境来实现回滚,相应的release-3.7.0分支删除,其它分支不要删除

分支版本号:

prd tapt. 蓝湖 版本号 保持一致

Git Commit Message规范

Git commit message规范指提交代码时编写的规范注释,编写良好的Commit messages可以达到3个重要的目的:

  • 加快代码review的流程

  • 帮助我们编写良好的版本发布日志

  • 让之后的维护者了解代码里出现特定变化和feature被添加的原因

Angular Git Commit Guidelines

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

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
  • type:提交类型

  • scope:可选项,本次 commit 波及的范围

  • subject:简明扼要的阐述下本次 commit 的主旨,在Angular Git Commit Guidelines中强调了三点。使用祈使句,首字母不要大写,结尾无需添加标点

  • body: 同样使用祈使句,在主体内容中我们需要把本次 commit 详细的描述一下,比如此次变更的动机

  • footer: 描述下与之关联的 issue 或 break change

简易版

项目中实际可以采用简易版规范:

  <type>(<scope>):<subject>

type规范

Angular Git Commit Guidelines中推荐的type类型如下:

  • feat: 新增功能

  • fix: 修复bug

  • docs: 仅文档更改

  • style: 不影响代码含义的更改(空白、格式设置、缺失 分号等)

  • refactor: 既不修复bug也不添加特性的代码更改

  • perf: 改进性能的代码更改

  • test: 添加缺少的测试或更正现有测试

  • chore: 对构建过程或辅助工具和库(如文档)的更改

除此之外,还有一些常用的类型:

  • delete:删除功能或文件

  • modify:修改功能

  • build:改变构建流程,新增依赖库、工具等(例如webpack、gulp、npm修改)

  • test:测试用例的新增、修改

  • ci:自动化流程配置修改

  • revert:回滚到上一个版本

单次提交注意事项

  • 提交问题必须为同一类别

  • 提交问题不要超过3个

  • 提交的commit发现不符合规范,git commit --amend -m "新的提交信息"git reset --hard HEAD 重新提交一次

配置.gitignore文件

.gitignore是一份用于忽略不必提交的文件的列表,项目中可以根据实际需求统一.gitignore文件,减少不必要的文件提交和冲突,净化代码库环境。

通用文件示例:

HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/
​
## STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
​
## IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
​
## NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/
​
## VS Code ###
.vscode/
​
# Log file
*.log
/logs*
​
# BlueJ files
*.ctxt
​
# Mobile Tools for Java (J2ME)
.mtj.tmp/
​
# Package Files #
*.jar
*.war
*.ear
*.zip
*.tar.gz
*.rar
*.cmd

其他

此外,还有一些其他建议:

  • master 分支的每一次更新,都建议打 tag 添加标签,通常为对应版本号,便于管理

  • feature分支、hotfix分支在合并后可以删除,避免分支过多管理混乱

  • 每次 pull 代码前,提交本地代码到本地库中,否则可能回出现合并代码出错,导致代码丢失

  • 每次提交说明清楚,“小步”前进

如何解决合并冲突

        feature(或hotix)分支合并到develop(或test、uat)冲突:

1、从develop分支checkout一个临时分支tmp_develop_XXX(或tmp_test_XXX),

2、然后把feature合并到tmp_develop_XXX(或tmp_test_XXX),合并过程的代码冲突在tmp__develop_XXX(或tmp_test_XXX)上解决(注意,不是在feature上,也不是在develop(或test)上)

3、解决完冲突后,把tmp_develop_XXX(或tmp_test_XXX)合并到develop(或test)

4、删除tmp_develop_XXX(或tmp_test_XXX)

关于maven仓库的管理

        1、目前maven仓库deploy操作暂时在develop/test/uat 分支进行,大家不要在其它分支上进行deploy操作,相关的操作规范正在完善

        2、将来计划,计划再弄一个开发专有maven私服,以后会有两套maven私服,以后的规范是以我们有两套私服为前提

常见问题

1、release分支发布到【正式环境】,在【正式环境】验证发现bug时,在哪个分支修复

        直接在release分支修复。修复完再发【正式环境】,再【线上验证】

2、线上验收通过后,支线开发分支是否可以删除

        如果支线开发分支已经合并到主线开发分支,则可以放心删除 ​ 如果支线开发分支的代码没有合并的到主线开发分支,则说明此次线上验证并没有此分支的代码,需要找相应的开发人员问清楚后处理

3、开发人员可以在哪些分支上【提交】代码

  feature分支release分支,只有release分支在线上验证发现bug时,才能在release分支提交代码hotfix分支其它一律禁止直接提交代码,

4、开发人员可以向哪些分支【合并】代码

  develop分支,主线featrue分支,

5、任何情况下,绝对禁止develop合并到其它任何分支(当然,有的工程仍没有完成规范改造,改造过程 中暂不用考虑此条)

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/28608.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

VMware 桥接网络突然无法上网

VMware 桥接网络突然无法上网 0. 问题1. 解决方法 0. 问题 昨天&#xff0c;VMware 桥接网络正常使用&#xff0c;今天突然无法上网。 1. 解决方法 打开VMware的虚拟网络编辑器&#xff0c;将桥接模式的网络从“自动”改成你要使用的网卡&#xff0c;问题解决。 完成&#…

通过命令行启动MySQL

通过命令行启动MySQL 右击&#xff0c;选择管理员运行 停止MySQL net stop你的服务名称 net stop MySQL启动MySQL net start你的服务名称 net start MySQL

ElasticSearch地理空间数据了解

ElasticSearch地理空间数据了解 使用场景 Elasticsearch 的地理空间数据处理功能在现代社会中有着广泛的应用&#xff0c;以下是一些常见的使用场景和方向&#xff1a; 1. 位置搜索和导航 本地服务发现&#xff1a;应用程序可以使用 Elasticsearch 查找用户附近的餐馆、商店…

【java分布式计算】分布式计算程序设计基础

期末复习 自留 重点只抓考点 目录 基本技术 SOCKETS网络套接字 多线程 数据序列化 Java I/O流 集合容器 范型 内部类、匿名类、Lambda&#xff08;代码&#xff09; 项目构建管理工具 高级技术 注解&#xff08;代码&#xff09; 反射&#xff08;代码&#xff09;…

C语言笔记第15篇:文件操作

1、为什么使用文件&#xff1f; 如果没有文件&#xff0c;我们写的程序的数据是存储在电脑的内存中&#xff0c;如果程序退出&#xff0c;内存回收&#xff0c;数据就丢失了&#xff0c;等再次运行程序&#xff0c;是看不到上次程序的数据的&#xff0c;如果要将数据进行持久化…

【PL理论】(29) OOP:面向对象编程 | 案例研究:C++ 中的类 | 继承 | 继承和指针 | Object-oriented Programming

&#x1f4ad; 写在前面&#xff1a;本章我们将进入 Object-oriented Programming&#xff0c;面向对象编程的讲解&#xff0c;探讨 C 中的类&#xff0c;继承等。 目录 0x00 面向对象编程 0x01 C语言中的结构体 0x02 案例研究&#xff1a;C 中的类 0x03 术语 0x04 继承&…

PHP调用阿里云OSS的SDK封装成服务的完整指南与问题解决

在现代Web开发中&#xff0c;使用云存储来管理和存储大量的静态文件已经成为常态。阿里云OSS&#xff08;对象存储服务&#xff09;是其中一个非常受欢迎的选择。在这篇文章中&#xff0c;我们将详细讲解如何在PHP项目中集成并使用阿里云OSS SDK。 #### 一、前期准备 在开始之…

vue3轮播图怎么做

先看效果 实现代码 <n-carouseleffect"card"dot-type"line"draggable:autoplay"!isHovered":current-index"currentIndex"prev-slide-style"transform: translateX(-150%) translateZ(-450px);opacity:1"next-slide-st…

【MySQL】(基础篇十三) —— 联结

联结 本文介绍什么是联结&#xff0c;为什么要使用联结&#xff0c;如何编写使用联结的SELECT语句。介绍如何对被联结的表使用表别名和聚集函数。 SQL最强大的功能之一就是能在数据检索查询的执行中联结&#xff08;join&#xff09;表。联结是利用SQL的SELECT能执行的最重要…

springboot+vue+mybatis教师工作审核系统+PPT+论文+讲解+售后

随着社会不断进步与发展&#xff0c;生活节奏不断加快&#xff0c;信息已经成为我们生活中不可缺少的一部分&#xff0c;很多学校需要掌握大量的信息来了解特定学生的需求&#xff0c;传统的做法是组织大量的人力物力对学生散发调查表&#xff0c;然后对收集的信息进行统计并得…

基于Matlab的BP神经网络的车牌识别系统(含GUI界面)【W7】

简介&#xff1a; 本系统结合了图像处理技术和机器学习方法&#xff08;BP神经网络&#xff09;&#xff0c;能够有效地实现车牌的自动识别。通过预处理、精确定位、字符分割和神经网络识别&#xff0c;系统能够准确地识别各种车牌图像&#xff0c;并在智能交通管理、安防监控等…

LeetCode 338.比特位计数

各位朋友们&#xff0c;大家好啊&#xff0c;今天此题我用的方法比较好理解&#xff0c;但时间复杂度比较高如果大家觉得可以的话&#xff0c;不妨给个免费的赞吧&#xff0c;谢谢了^ _ ^ 1.题目要求如图所示: 2.做题步骤: 1.先计算总共多少个数: int count 0;int number 0;…

25 avl树

目录 底层结构avl树的概念节点定义插入旋转验证删除全性能 1. 底层结构 前面对map/multimap/set/multiset进行了简单的介绍&#xff0c;在其文档介绍中发现&#xff0c;这几个容器有几个共同点是&#xff1a;其底层都是按照二叉搜索树来实现的&#xff0c;但是二叉搜索树有自…

Android.mk的用法

前言 Android.mk 文件是 Android 编译系统中用于描述项目源文件、库和模块的 Makefile。它采用 GNU Make 的语法,但也包含了一些特定于 Android 编译系统的规则和变量。以下是对其语法和使用方法的详细解释及示例。 一:模块种类 一个Android.mk file用来向编译系统描述你的源…

用Copilot画漫画,Luma AI生成视频:解锁创意新玩法

近年来&#xff0c;随着人工智能技术的不断发展&#xff0c;各种创意工具也层出不穷。今天&#xff0c;我们就来介绍一种全新的创作方式&#xff1a;使用Copilot画漫画&#xff0c;再将漫画放入Luma AI生成视频。 Copilot&#xff1a;你的AI绘画助手 Copilot是一款基于人工智…

使用sherpa-ncnn进行中文语音识别(ubuntu22)

获取该开源项目的渠道&#xff0c;是我在b站上&#xff0c;看到了由csukuangfj制作的一套语音识别视频。以下地址均为csukuangfj在视频中提供&#xff0c;感谢分享&#xff01; 新一代Kaldi RISC-V: VisionFive2 上的实时中英文语音识别_哔哩哔哩_bilibili 开源项目地址&…

如何将扫描的 PDF 转换为 Word

您是否正在寻找一种可靠且轻松的方式将扫描的 PDF 文档转换为可编辑的 Word 文件&#xff1f;要将 PDF 转换为可编辑的 Word 文档&#xff0c;神奇之处在于光学字符识别(OCR)。 使用 PDFgear&#xff0c;您可以无缝地将扫描的 PDF 转换为 Word&#xff0c;无论是在线还是离线。…

内网Docker镜像无法使用?Debian/Ubuntu离线安装Dokcer

离线安装Docker 卸载冲突的包 for pkg in docker.io docker-doc docker-compose podman-docker containerd runc; do sudo apt-get remove $pkg; done先删除docker sudo apt-get purge docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin d…

CLIP-guided Prototype Modulating for Few-shot Action Recognition

标题&#xff1a;基于CLIP引导的原型调制用于少样本动作识别 源文链接&#xff1a;CLIP-guided Prototype Modulating for Few-shot Action Recognition | International Journal of Computer Vision (springer.com)https://link.springer.com/article/10.1007/s11263-023-019…

awd工具安装

fscan(漏洞扫描) 下载 下载地址: Releases shadow1ng/fscan GitHub 把下载的文件放到指定文件目录里, 在文件的位置打开cmd 输入 fscan64.exe -h 192.168.1.1/24 ok了 接下来说说fscan的使用 使用 1.信息搜集: 存活探测(icmp) 端口扫描 2.爆破功能: 各类服务爆破(…