后端必备的 Git 分支开发规范指南 转

原文链接 作者:稻草叔叔 http://juejin.im/post/5b4328bbf265da0fa21a6820

点击上方 “后端技术精选”,选择 “置顶公众号”

技术文章第一时间送达!

作者:稻草叔叔

juejin.im/post/5b4328bbf265da0fa21a6820

Git 是目前最流行的源代码管理工具。为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,现规范 git 的相关操作。

分支管理

分支命名

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?release?--no-ff??????????#?把release测试好的代码合并到master,运维人员操作
(master)$:?git?tag?-a?v0.1?-m?'部署包版本名'??#给版本命名,打Tag

日志规范

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

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

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

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

Commit messages 的基本语法

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

https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-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地址或者其它文档

参考链接

http://www.ruanyifeng.com/blog/2012/07/git.html
http://ivweb.io/topic/58abda9d2117ae2f4995b4a8
https://segmentfault.com/a/1190000009048911

推荐阅读 (点击即可跳转阅读)

1.?SpringBoot 内容聚合

2.?面试题内容聚合

3.?设计模式内容聚合

4.?Mybatis 内容聚合

5.?多线程内容聚合

原文地址:https://www.cnblogs.com/wangdaijun/p/11768280.html

时间: 2024-10-25 18:25:08

后端必备的 Git 分支开发规范指南 转的相关文章

团队项目的Git分支管理规范

原文地址: http://blog.jboost.cn/2019/06/17/git-branch.html 许多公司的开发团队都采用Git来做代码版本控制.如何有效地协同开发人员之间,以及开发.测试.上线各环节的工作,可能都有各自的流程与规范.本文分享的是作者一直沿用的团队项目Git分支管理规范,希望给有缘阅读的人以参考,如果有更好的实践,也欢迎探讨.交流. 分支管理 创建项目时(一般是服务型项目,工具型或辅助型项目可以简单一些),会针对不同环境创建三个常设分支: develop:开发环境的稳

Git分支管理规范

关于Git的一些分支管理规范... 一.分支与角色说明 Git 分支类型 master 分支(主分支) 稳定版本 develop 分支(开发分支) 最新版本 release 分支(发布分支) 发布新版本 hotfix 分支(热修复分支) 修复线上Bug feature 分支(特性分支) 实现新特性 Gitlab 角色与项目角色对应关系 Owner(拥有者) Git 管理员 Master(管理员) 开发主管 Developer(开发者) 开发人员 Reporter(报告者) 测试人员 Guest(

git 分支管理规范

保证master分支永远处于可部署的状态.禁止自接提交代码到master分支 开发分支基于master分支创建,命名规范如下: 如果是功能需求,分支命名为feature/xxx,xxx要具有描述性 如果是线上bugfix,分支命名为hotfix/xxx,xxx要具有描述性 需要发布的时候基于master分支新拉一个release分支,并提交一个Merge Request申请将feature分支合并到release分支,指定一个人进行code review,没问题之后再进行合并,然后使用relea

项目Git分支管理规范

Git 是一个开源的分布式版本控制系统,用于敏捷高效地处理任何或小或大的项目. 一.分支管理 项目中,一般会创建三个常用分支: develop:开发环境的稳定分支,公共开发环境基于该分支构建. pre-release:测试环境的稳定分支,测试环境基于该分支构建. master:生产环境的稳定分支,生产环境基于该分支构建. 日常开发中,一般会创建两类分支: 功能(feature)分支:为开发某个特定功能,从develop分支上面分出来的.开发完成后,要merge到develop分支.功能分支的命名

Git &amp; Gitlab 开发规范流程

第一步:clone开发分支到本地 源仓库建立以后,开发者需要自己去复制一份到本地 #获取源仓库项目 #旧版本为例 $ git clone [email protected]:hello/ta.git 第二步:新建分支 首先,每次开发新功能,都应该新建一个单独的分支 #新建一个开发分支 $ git checkout –b xxxxx #获取分支最新代码 $ git pull origin dev 第三步:提交commit 分支修改后,就可以提交commit了 $ git add . / git a

5分钟入门git模式开发

本文由云+社区发表 作者:唐维黎 导语 基于gui工具TortoiseGit让你快速进入git开发模式. 目前项目已逐步从svn移步到git开发模式,其中也针对git统一协议了适合git的开发规范, 最重要一点就是分支模型的,为了规范开发,不直接在主干上修改代码,一切代码都提交至分支dev,然后再由分支合并到主干master. 首先保证每个仓库下有以下两个常驻分支(永远不删除的分支): master:主干分支,始终保持跟外网服务器一致,只用于外网发布,这样就可以保证文件不会带出去的风险: dev

Git 分支模型与开发规范

01.分支模型 master:长期分支,一般用于管理对外发布版本,每个 commit 对一个 tag,也就是一个发布版本 develop:长期分支,一般用于作为日常开发汇总,即开发版的代码 feature: 短期分支,一般用于一个新功能的开发 hotfix :短期分支 ,一般用于正式发布以后,出现 bug,需要创建一个分支,进行 bug 修补. release :短期分支,一般用于发布正式版本之前(即合并到 master 分支之前),需要有的预发布的版本进行测试. master和develop作

一个成功的 Git 分支模型(适用于商业应用开发)

在这篇文章中,我将推广一下大约一年前我介绍过的一些项目(公私皆有)中使用的开发模型,它们的结果都非常成功.有段时间我非常想写出来分享一下,但是我至今才抽出时间来.我不会言及任何项目细节,仅讨论分支策略和发布管理. 为何使用 git? 关于 Git 和集中式源码版本控制系统的优缺点对比讨论, 见 此 web.这里有很多精彩激烈的论战.作为一名开发者,现在我更偏好使用 Git .Git 真的改变了开发者关于合并和分支的认知.我来自传统的 CVS/Subversion 世界,合并/分支是件恐怖的事情

必备技能-Git 使用规范流程

团队开发中,遵循一个合理.清晰的Git使用流程,是非常重要的. 否则,每个人都提交一堆杂乱无章的commit,项目很快就会变得难以协调和维护. 下面是ThoughtBot 的Git使用规范流程.我从中学到了很多,推荐你也这样使用Git. 第一步:新建分支 首先,每次开发新功能,都应该新建一个单独的分支(这方面可以参考<Git分支管理策略>). # 获取主干最新代码 $ git checkout master $ git pull # 新建一个开发分支myfeature $ git checko