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

梦里梦外; 2022-12-14 03:47 284阅读 0赞

点击上方“java大数据修炼之道”,选择“设为星标”

# 优质文章和精品资源, 第一时间送达![format_png][] #

![format_png 1][]

https://www.cnblogs.com/heroljy/p/9294127.html

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

![format_png 2][]

## 日志规范 ##

在一个团队协作的项目中，开发人员需要经常提交一些代码去修复bug或者实现新的feature。

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

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

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

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

![format_png 3][]

## Commit messages的基本语法 ##

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

> “
> 
> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md\#-git-commit-guidelines

具体格式为:

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地址或者其它文档

![format_png 4][]

**推荐阅读：**

#### 1、[建议收藏 | Redis 使用 10 个小技巧][_ Redis _ 10]     2、[一款SQL自动检查神器，再也不用担心SQL出错了，自动补全、回滚等功能大全][SQL_SQL]  3、[项目中常用的19条MySQL优化][19_MySQL]  4、[单怼多线程，60道面试题，你能答上几个？（附答案）][60]  5、[这21 个刁钻的HashMap 面试题，我把阿里面试官吊打了！][21 _HashMap]  6、[Java开发必须掌握的 20+ 种 Spring 常用注解][Java_ 20_ _ Spring]     7、[老要求用java将word转为PDF，这么搞？][java_word_PDF]     8、[Redis分布式锁没用明白，搞出了大故障…][Redis]  9、[程序员面试 10 大潜规则，千万不要踩坑！][10]     10、[*【收藏了】10分钟读懂进程线程、同步异步、阻塞非阻塞、并发并行*][10 1] ####

**看完有收获?请转发分享给更多有需要的人**

关注 java大数据修炼之道

每天学习java技术，你想学的Java知识这里都有!**![format_png 5][]**

![format_png 6][]微信扫描二维码，关注我的公众号

写留言

*  
 *  ####  ####
    
    如果对你有帮助,请点个"在看 ![format_png 7][]",谢谢 ![format_png 8][]

[format_png]: /images/20221123/0e337872e9034912b30c8fecc754db84.png
[format_png 1]: /images/20221123/a888bea979ed422b9505ea3ec1c06558.png
[format_png 2]: /images/20221123/6247ecdb366c4c728131e4265583f43b.png
[format_png 3]: /images/20221123/65c8e60de44944a3ba90d48c9a838efd.png
[format_png 4]: /images/20221123/1c04d1a6e49f4698845c7e7caf7f9fc9.png
[_ Redis _ 10]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22e05ccb5a713216d76a47efd7e4144ab9be9616235630f5f4edea4c8615182203fb8ef74&idx=1&mid=2247491785&scene=21&sn=a8cae67660d5733f1da6003c50d3529f#wechat_redirect
[SQL_SQL]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22a13ccb5a305f809cc500952a30c90dc6fbfc8e622ff7ba78b85e64f1ceda60ac8e8ad1c&idx=1&mid=2247492831&scene=21&sn=8b98b8982b38e236f0a798d55f1a46af#wechat_redirect
[19_MySQL]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22c17ccb5a501df41ddeaecf0f7e85e292b45d6c7522e4d6a4d9c4a93a389338ee175eae8&idx=1&mid=2247492315&scene=21&sn=37c6888e30892c7fae56d0769c35a571#wechat_redirect
[60]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc1d557ccb65c41ec5d3b7dedd6c7a22949ddcb5de1406de482c3b702a1a4768c66b730b219&idx=1&mid=2247490459&scene=21&sn=66bc23ae41a8abcb9a6f00be754b2e47#wechat_redirect
[21 _HashMap]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc1d429ccb65d3fc4be6ab008e4318d3beeccb1394801c72e33cbb9fd162868dce2b9b0c0f2&idx=1&mid=2247490277&scene=21&sn=63d44db7ae6930f25478119f423227d4#wechat_redirect
[Java_ 20_ _ Spring]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22d67ccb5a471b0eb2969ac654b6d01b0c93d9c317164658f0486d5420f585c12599c56bd&idx=1&mid=2247492523&scene=21&sn=0c62a1d6bd02b85bc027d607286199b0#wechat_redirect
[java_word_PDF]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22dc7ccb5a4d1b94f2a9bbce26082c9f845fbbf7d588a5540d072bcef39b2281d0b705f91&idx=1&mid=2247492363&scene=21&sn=6975a1a5de92dc49d04654f21ffa7c21#wechat_redirect
[Redis]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc1d038ccb6592e2d08ccd07a31a069ebbfc64d9abd2d1cfd88dba5efc1439f14cc78392bf3&idx=1&mid=2247491316&scene=21&sn=59fdccb5447abec7e33c881110c5be1f#wechat_redirect
[10]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc22cc6ccb5a5d09ec368b85dfe087d1b68f6ccbf67d7275356f64f203d353dcba684b4012e&idx=1&mid=2247492106&scene=21&sn=e25c3eea649006f34fd6f5cb62ea78be#wechat_redirect
[10 1]: http://mp.weixin.qq.com/s?__biz=MzU1NjczNTM5NQ%3D%3D&chksm=fbc1d748ccb65e5e8bfe2334dac9c4a1678fa77a4b1c6bb230fb4442682c36120cfb8d8941ae&idx=1&mid=2247489924&scene=21&sn=40b4b841430ae75879b25545291dbf0a#wechat_redirect
[format_png 5]: /images/20221123/9f7cdab629664b20a03e56b06e3c3614.png
[format_png 6]: /images/20221123/bd61ba86bc11401bbde77828a444c1ef.png
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy9DMXVETURxam4xOXd0dVFwSzNqbUpXM2JGR1dJOFl6NkZSMTd0bDFNRjhWZnFZeFB4OTkwa3YySjc0THZxd2liMjZLYXlIZE9YZDZlYnpycVlpYmJUand3LzY0MA?x-oss-process=image/format,png
[format_png 8]: /images/20221123/a8e1e2a819044b72b8280da99f80fe0c.png