来源:https://juejin.im/post/684490...

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

分支命名

1、master 分支

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

2、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/an...

具体格式为:

<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

  • type: 本次 commit 的类型,诸如 bugfix docs style 等
  • scope: 本次 commit 波及的范围
  • subject: 简明扼要的阐述下本次 commit 的主旨,在原文中特意强调了几点:
  • 使用祈使句,是不是很熟悉又陌生的一个词
  • 首字母不要大写
  • 结尾无需添加标点

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

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

Type的类别说明:

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

Commit messages格式要求

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

如有帮助,请点赞三连来一波支持。

合并分支到master_我敢打赌!这是全网最全的 Git 分支开发规范手册相关推荐

  1. 如何删除本地/远程Git分支

    目录 删除本地分支 删除远程分支 如何删除所有非合并的Git分支? 删除所有不在远程上的本地分支 删除除Master以外的所有本地Git分支 结论 在本文中,您将在定义什么是Git分支以及删除分支的副 ...

  2. Git 分支管理常见三种方式

    Git 分支管理常见三种方式 TBD(Trunk-based development.单主干) GitHub flow git-flow 1. TBD 所有团队成员都在单个主干分支上进行开发. 发布时 ...

  3. Idea中刷新Git分支列表

    Idea中使用Git查看分支列表的时候,总是不出现新的分支或者远程已经没有的分支在本地还有,这时就需要更新下本地的git分支保持和远程分支一致,使用下面几个方法都可以. 方法一,Update Proj ...

  4. IDEA如何将git分支代码合并到master

    IDEA如何将git分支代码合并到master 1. 打开默认开发分支(svn_develop) 2. 将远程master分支Checkout as new local brabch  确保代码与远程 ...

  5. 【Git】Git 分支管理 ( 解决分支合并冲突 | 本地处理文件冲突 )

    文章目录 一.本地处理文件冲突 一.本地处理文件冲突 在下面的 [Git]Git 分支管理 ( 解决分支合并冲突 | 创建并切换分支 git switch -c feature1 | 修改 featu ...

  6. git分支操作、分支合并冲突解决

    目录 git bash分支命令 git bash分支简单操作 git bash分支合并冲突修改 git bash分支命令 注意:切换分支的时候,本地.暂存区的文件依然在本地.暂存区.也就是只是切换本地 ...

  7. c++两个vector合并_这才是真正的 Git——分支合并

    本文作者:lzaneli,腾讯 TEG 前端开发工程师 "合并前文件还在的,合并后就不见了"."我遇到 Git 合并的 bug 了" 是两句经常听到的话,但真的 ...

  8. 这才是真正的 Git——分支合并

    本文作者:lzaneli,腾讯 TEG 前端开发工程师 "合并前文件还在的,合并后就不见了"."我遇到 Git 合并的 bug 了" 是两句经常听到的话,但真的 ...

  9. Git分支创建、合并、上传等命令

    Git分支创建.合并.上传等命令 一. 创建test分支提交步骤 1.列出所有分支 git branch -a 2.创建test分支 git branch test 3.切换到test分支: git ...

最新文章

  1. 组装电脑配置单报价_哪家电脑店胆子这么大,竟敢用这种方式组装电脑,客户傻得无辜!...
  2. 函数图像轻松画:教你用永中图象
  3. Android实时监听网络状态
  4. linux shell脚本写法,linux: 常用shell脚本写法
  5. 09_分类算法--k近邻算法(KNN)、案例、欧氏距离、k-近邻算法API、KNeighborsClassifier、及其里面的案例(网络资料+学习资料整理笔记)
  6. HDU - 2049 不容易系列之(4)——考新郎(错排问题+组合数学)
  7. python、中循环功能可通过什么命令实现_python定时执行指定函数的方法 Python如何定时循环执行命令?...
  8. css里slidebottom,jquery - 从CSS“top”到“bottom”的jQuery动画 - 堆栈内存溢出
  9. 20 WM配置-策略-定义出库排序序列(拣配)
  10. 64位 mxcomponent_三菱MX Component 4.16S下载
  11. 物联网开发语言的探讨
  12. 海康威视录像机(DVR)卡在开机画面
  13. 如何将CHM文件翻译成中文
  14. 深入理解深度学习——Item Embedding
  15. 聪明的人脸识别4——Pytorch 利用Retinaface+Facenet搭建人脸识别平台
  16. 数据分析进阶必看干货!销售额下滑详细分析案例
  17. 中秋节的月亮怎么拍?不用手机和相机,程序员照样能拍出大片的感觉
  18. 如何解决ssh断开/关闭之后python程序自动中止
  19. 申请成为第三方支付公司的基本条件
  20. 硬件断点和软件断点的区别

热门文章

  1. 【数学与算法】曲线上各点的曲率kappa和倾角theta
  2. Batch Normalization 学习笔记
  3. Android模拟器Genymotion使用详解
  4. spring框架学习(三)junit单元测试
  5. 【Visual C++】一些开发心得与调试技巧
  6. 深度学习(二十六)Network In Network学习笔记-ICLR 2014
  7. 图像代数运算:平均值去噪,减去背景
  8. 人工智能:第八章 自动规划
  9. 盘点那些你可能错过的CNCF优秀开源项目
  10. SQL 基础正则表达式(二十三)