【软件开发规范篇】Git分支使用规范

作者介绍:本人笔名姑苏老陈,从事JAVA开发工作十多年了,带过刚毕业的实习生,也带过技术团队。最近有个朋友的表弟,马上要大学毕业了,想从事JAVA开发工作,但不知道从何处入手。于是,产生了写一个博客专栏想法,介绍当前互联网企业JAVA项目开发如何快速入门。

本文收录于《30天企业JAVA项目开发实战入门》专栏,该专栏内容以当前互联网软件企业中的项目实战为线索,介绍企业JAVA项目开发中涉及到的开发流程、技术、工具、规范要求等等。帮助想从事JAVA开发的大学生或新人,更快的、更好的入门JAVA后端开发工作。

一、前言

本文介绍一下软件开发过程中,Git分支使用规范。

在团队开发中,遵循一个合理、清晰的 Git 使用流程,是非常重要的。否则,各种不清晰的分支结构,后续产品迭代或维护都会让人很头疼。

几乎所有的版本控制系统都以某种形式支持分支。 使用分支意味着你可以把你的工作从开发主线上分离开来,以免影响开发主线。

有人把 Git 的分支模型称为它的“必杀技特性”,因为基于指针的实现使其足够轻量。

Git 鼓励在工作流程中频繁地使用分支与合并,哪怕一天之内进行许多次,但仍要遵循一定的规范。

Git工作流程图:
在这里插入图片描述

二、分支命名管理

开发过程主要存在以下分支:

  • master
  • dev
  • hotfix-[问题名称 | bug编号]
  • feature-yyyyMMdd_需求名称
  • bugfix-[bug编号]
  • refactor-[重构名称]

master

- master主分支始终保持稳定的可发布版本,所以一般不允许直接在该分支上修改代码;
- 只有项目组主程才拥有master主分支的管理权限(例如其他分支合并到master必须由主程操作);

dev

- dev为开发分支,要能保证能运行, 不能编译错误;
- 始终保持最新完成以及bug修复后的代码;
- 一般开发新功能时,feature 分支都是基于 develop分支下创建的;

hotfix

- 建议格式为hotfix-[问题名称 | bug编号];
- 线上出现紧急问题时,需要及时修复,以 master 分支为基线,创建 hotfix 分支,修复完成后,需要合并到master 分支和 dev 分支;

feature

- 建议格式为feature_yyyyMMdd_需求名;
- 开发新功能时,以dev分支为基础创建 feature 分支;
- 如果有codereview, 应由一人审核后合并至dev;

bugfix

- 建议格式为bugfix-[bug编号];
- 从dev分支创建,用于修改测试提出的bug,修复以后,在远程发起向dev分支的合并请求,合并以后删除该分支;

refactor

- 建议格式为refactor-[重构名称];
- 从dev分支创建,用于代码的**重大规模重构**(小规模重构创建feature分支即可);
- 重构以后,必须经过严格测试通过,才能向dev分支合并;

三、分支操作流程

  1. 需求分类(中长期需求, 跨版本需求等);
  2. 由专人按统一的命名格式, 切分支;
  3. 各人拉取各自分支开发;
  4. 开发完后, 提交代码
    (1)若有codeview, 由专人浏览后合并到dev;
    (2)若没有, 则自行同步dev上的最新代码到本分支, 然后合并本分支代码到dev(规避代码覆盖问题);
  5. 分支开发的时间过久, 则需要定时拉取dev分支到自己业务分支上, 减少后续解决冲突的工作量;
  6. 如果测试过程中存在 bug 需要修复,则由开发者在dev上拉取bugfix分支修改bug,完成后合并到dev分
    支上;
  7. dev分支的代码测试没有问题, 合并到master, master分支打好tag或做好备份, 通知运维准备上线;
  8. 若开发中突遇紧急bug, 需从master上拉取最新代码到本地称为hotfix分支, 改完测试后合并到master分支,通知运维发布。

四、总结

以上规范不一定是必须的,一般是根据实际情况来的,总结如下:

  • 自己的分支一定要自测,切记不要提交后,影响到其他代码,更别说别人拉下代码还报错这种低级错误;
  • 本地分支要做到勤提交,分小功能提交,一次提交一大堆各种功能的做法也要杜绝;
  • 每天第一件事就是更新 develop 分支内容到本地分支,避免大规模 merge,太容易出错了;
  • 迭代新版本时,一定要保证当前开发分支和线上分支一样;
  • 23
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
企业软件开发Git分支开发规范是指在软件开发过程中,基于Git版本控制工具的使用约定和规范。以下是一个简单的Git分支开发规范的例子: 1. 主分支:一般情况下,主分支(通常为master或main)用于存储稳定可用的代码开发人员应该遵循向主分支合并代码前进行充分的测试和验证。 2. 功能分支:为了开展新功能开发,应从主分支分出一个功能分支。该分支名称应描述该分支所要实现的具体功能。功能分支的创建可以使用Git命令`git branch <branch-name>`。 3. 开发分支:在大型项目中,可以将功能分支进一步划分为多个开发分支。每个开发人员在自己的开发分支上独立工作,不会影响其他人的进度。对于每个开发人员的开发分支,可以使用Git命令`git checkout -b <developer-name/branch-name>`。 4. 提交规范:为了保持代码提交的清晰可读性,应遵循良好的提交规范。每次提交应包含有意义的备注信息,以便其他开发人员能够轻松理解具体的更改。可以使用Git命令`git commit -m "commit message"`来提交更改。 5. 合并和解决冲突:在开发过程中,可能会出现多个开发人员同时在同一个分支上进行工作,导致冲突。为了解决冲突,应使用Git的合并工具,并在合并之前与其他开发人员进行充分的协调和讨论。 6. 定期合并到主分支:在功能或开发分支开发完成、经过测试验证后,应将其合并到主分支。可以使用Git命令`git merge <branch-name>`将分支合并到主分支。 7. 删除不再需要的分支:一旦分支的工作已经合并到主分支,并且不再需要,应该将其删除,以保持代码的整洁。可以使用Git命令`git branch -d <branch-name>`删除分支。 以上只是一个示例,具体的企业软件开发Git分支开发规范可以根据实际项目需要进行调整和扩展。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

姑苏老陈

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值