项目组GIT操作规范

2024-05-14 11:04
文章标签 操作 git 规范 项目组

本文主要是介绍项目组GIT操作规范,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

分支规范

在开发过程中,一般会存在以下几种分支:

  • main分支(master)
    master为主分支,也是用于部署生产环境的分支,一般由 dev 以及 fixbug分支合并,任何时间都不能直接修改代码。
  • dev分支
    develop 为开发分支,始终保持最新完成以及bug修复后的代码。一般开发新功能时,feature 分支都是基于 dev 分支下创建的。
  • feature-[功能名称/版本信息]
    feature为需求分支,以 dev 分支为基础创建 feature 分支。每个开发人员基于feature分支,创建自己的开发分支。
  • fixbug-[bug编号]
    线上出现紧急问题时,需要及时修复,以 master 分支为基线,创建 fixbug分支,修复完成后,需要合并到 master 分支和 dev 分支。

注意:

  • 使用git pull定期从远程仓库拉取更新并与本地分支同步,避免出现长时间不更新导致合并时产生大量冲突的情况。
  • 合并代码前,运行git fetch获取远程分支最新状态,然后使用git mergegit rebase进行合并,并解决可能发生的冲突。
  • 定期清理不再需要的功能分支,完成并合并后删除它们以保持分支列表清晰。

常用分支命令

git branch -r  #远程仓库分支
git branch -a  #所有分支列表
git branch #新分支名称
git checkout branchName #切换分支
#创建分支并切换
git checkout -b branchName#删除本地分支,当分支被推送并合并到远程分支后-d才会删除本地分支
git branch -d localBranchName
#删除远程分支
git push origin --delete remoteBranchName#推送本地分支到远程分支(远程暂时无对应分支)
git push origin localBranch:remoteBranch
#拉取远程分支到本地(在本地创建分支并自动切换到新分支并且与远程分支建立映射关系)
git checkout -b localBranch origin/remoteName

Commit 提交规范

  1. 提交的日志格式
    每次git提交日志格式为: 类型:描述
    类型:用于说明 commit 的类别,只允许使用下面7个标识。

    • feat:新功能
    • fix:修补bug
    • docs:修改文档
    • style: 格式化代码结构,没有逻辑上的代码修改
    • refactor:重构,即不是新增功能,也不是修改bug的代码变动,比如重命名变量
    • test:增加测试代码,单元测试一类的,没有生产代码的变更
    • chore:构建过程或辅助工具的变动(不会影响代码运行)

    描述:是本次commit的描述,说明白本次提交都干了些啥
    例如:

git commit -m "feat: 新增用户详情页接口"
git commit -m "fix: 修复用户注册时电话号码校验逻辑问题" 
git commit -m "docs: 新增项目Readme 文档"
  1. 提交频率
    • 提交粒度按照功能点进行提交,切记不要一直不提交,积攒一大堆代码再提交;

更新、合并规范

原则:

  1. 下游分支更新上游分支代码用rebase
  2. 上游分支合并下游分支代码用merge
  3. 更新本分支代码用--rebase (如果本分支有多人共同使用开发的时候);
    这样可以消除自动产生的无用merge记录,有利于后续查看开发记录。

下游分支在更新上游分支代码的时候,如果使用merge,会产生一条无用的合并记录,比较影响查看历史,使用rebase则不会。

分场景介绍

目前有个xx需求,由a、b两名同事进行开发分支说明(建立个人开发分支是为了方便做代码review)

  • master:主分支
  • dev:测试分支
  • Feature--xx:订单详情需求分支
  • Feature--xx-a:订单详情a开发分支
  • Feature--xx-b:订单详情b开发分支

master主分支内容
在这里插入图片描述
当前所有分支都基于master分支进行创建,内容与master分支一致。

场景一feature--xx分支代码有个更新,本地feature--xx更新代码。

远程分支新增一个类,如下
在这里插入图片描述

# 目前代码处于feature--xx分支,且都已经本地提交(没提交的可以使用暂存功能) 同步远程库代码变动 
$ git fetch origin 
# 使用rebase进行代码更新代码
$ git pull origin feature--xx --rebase

在这里插入图片描述
备注:

git fetch #拉取代码,需要使用git merge进行合并
git pull #拉取代码,会直接将本地代码更新至远程仓库里面最新的版本
# 也可使用IDEA自带功能(具体不再详述)

场景二feature--xx分支代码有了新代码的更新,a要合并代码。

梳理下思路:

  1. feature--xx-a更新远程分支代码(不更新也行,因为只有a在使用);
  2. 合并origin/feature-xx分支代码,有冲突解决冲突,没有冲突将代码push到服务器;
  3. 发起合并。

远程feature-xx分支新增输出内容
在这里插入图片描述
操作步骤

# 假设所有代码已经都提交,无需进行提交或者暂存代码的操作; 
$ git checkout feature--xx-a 
# 同步远程库代码变动 
$ git fetch origin 
# 使用rebase进行代码合并(合并上层分支到下层) 
$ git rebase origin/feature--xx 
# 如果此时有冲突,解决冲突,并将解决完冲突的代码提交,在执行rebase 即可 
$ git rebase --continue 

合并后如下
在这里插入图片描述

# 合并完之后,push代码,push完之后,a的代码已经到远程feature-xx-a分支了 
$ git push  # 此时,如果需要进行代码审核,发起一个合并请求即可; 
# 如果不需要进行代码审核,后续操作就是合并到feature--xx分支 
# 切换分支,并更新代码 
$ git checkout feature--xx 

在这里插入图片描述

$ git pull --rebase  
# 合并张三分支代码,并推送远程 
$ git merge feature--xx-a 

在这里插入图片描述

#  git push --set-upstream origin feature--xx
$ git push

分支使用及发版流程

负责人排定发行版计划,并执行发行版控制,注意前/后端的协同。测试版本可根据开发计划,拆解生产版本任务,组织阶段测试。

提测通过后拉分支继续开发、版本内有bug修复后合到已提交版本重新发版。具体流程如下:在这里插入图片描述

这篇关于项目组GIT操作规范的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/988572

相关文章

IDEA和GIT关于文件中LF和CRLF问题及解决

《IDEA和GIT关于文件中LF和CRLF问题及解决》文章总结:因IDEA默认使用CRLF换行符导致Shell脚本在Linux运行报错,需在编辑器和Git中统一为LF,通过调整Git的core.aut... 目录问题描述问题思考解决过程总结问题描述项目软件安装shell脚本上git仓库管理,但拉取后,上l

使用Java填充Word模板的操作指南

《使用Java填充Word模板的操作指南》本文介绍了Java填充Word模板的实现方法,包括文本、列表和复选框的填充,首先通过Word域功能设置模板变量,然后使用poi-tl、aspose-words... 目录前言一、设置word模板普通字段列表字段复选框二、代码1. 引入POM2. 模板放入项目3.代码

利用Python操作Word文档页码的实际应用

《利用Python操作Word文档页码的实际应用》在撰写长篇文档时,经常需要将文档分成多个节,每个节都需要单独的页码,下面:本文主要介绍利用Python操作Word文档页码的相关资料,文中通过代码... 目录需求:文档详情:要求:该程序的功能是:总结需求:一次性处理24个文档的页码。文档详情:1、每个

Python内存管理机制之垃圾回收与引用计数操作全过程

《Python内存管理机制之垃圾回收与引用计数操作全过程》SQLAlchemy是Python中最流行的ORM(对象关系映射)框架之一,它提供了高效且灵活的数据库操作方式,本文将介绍如何使用SQLAlc... 目录安装核心概念连接数据库定义数据模型创建数据库表基本CRUD操作创建数据读取数据更新数据删除数据查

Go语言中json操作的实现

《Go语言中json操作的实现》本文主要介绍了Go语言中的json操作的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录 一、jsOChina编程N 与 Go 类型对应关系️ 二、基本操作:编码与解码 三、结构体标签(Struc

Java 字符串操作之contains 和 substring 方法最佳实践与常见问题

《Java字符串操作之contains和substring方法最佳实践与常见问题》本文给大家详细介绍Java字符串操作之contains和substring方法最佳实践与常见问题,本文结合实例... 目录一、contains 方法详解1. 方法定义与语法2. 底层实现原理3. 使用示例4. 注意事项二、su

Git进行版本控制的实战指南

《Git进行版本控制的实战指南》Git是一种分布式版本控制系统,广泛应用于软件开发中,它可以记录和管理项目的历史修改,并支持多人协作开发,通过Git,开发者可以轻松地跟踪代码变更、合并分支、回退版本等... 目录一、Git核心概念解析二、环境搭建与配置1. 安装Git(Windows示例)2. 基础配置(必

Git打标签从本地创建到远端推送的详细流程

《Git打标签从本地创建到远端推送的详细流程》在软件开发中,Git标签(Tag)是为发布版本、标记里程碑量身定制的“快照锚点”,它能永久记录项目历史中的关键节点,然而,仅创建本地标签往往不够,如何将其... 目录一、标签的两种“形态”二、本地创建与查看1. 打附注标http://www.chinasem.cn

Java Stream流与使用操作指南

《JavaStream流与使用操作指南》Stream不是数据结构,而是一种高级的数据处理工具,允许你以声明式的方式处理数据集合,类似于SQL语句操作数据库,本文给大家介绍JavaStream流与使用... 目录一、什么是stream流二、创建stream流1.单列集合创建stream流2.双列集合创建str

Python正则表达式匹配和替换的操作指南

《Python正则表达式匹配和替换的操作指南》正则表达式是处理文本的强大工具,Python通过re模块提供了完整的正则表达式功能,本文将通过代码示例详细介绍Python中的正则匹配和替换操作,需要的朋... 目录基础语法导入re模块基本元字符常用匹配方法1. re.match() - 从字符串开头匹配2.