Git分支开发规范
- 1. 初衷
- 2. 分支管理
- 3. [本地分支和远程分支建立追踪关系的三种方式](https://blog.csdn.net/qq_42780289/article/details/97762596)
- 4. [git如何合并远程2个分支](https://www.cnblogs.com/personblog/p/11240422.html)
- 5. [ git checkout 可替换命令 git switch 和 git restore](https://www.cnblogs.com/tinywan/p/12344267.html)
- 6. 日志规范
- 7. 依托github创建多分支项目
- 8. [git stash详解](https://blog.csdn.net/stone_yw/article/details/80795669)
- 9.[Git常用命令及方法大全](https://www.cnblogs.com/miracle77hp/articles/11163532.html)
- 10. [解决Git 克隆代码 The remote end hung up unexpectedly错误](https://www.jianshu.com/p/5f2348927504)
- 10. 寄语:无论从事什么行业,只要做好两件事就够了,一个是你的专业、一个是你的人品,专业决定了你的存在,人品决定了你的人脉,剩下的就是坚持,用善良和真诚赢取更多的信任
1. 初衷
- Git 是目前最流行的源代码管理工具。 为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,现规范 git 的相关操作。
2. 分支管理
2.1. 分支命名
-
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分支
2.2. 常见任务
-
增加新功能
(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 testing --no-ff # 把testing测试好的代码合并到master,运维人员操作 (master)$: git tag -a v0.1 -m '部署包版本名' #给版本命名,打Tag
3. 本地分支和远程分支建立追踪关系的三种方式
4. git如何合并远程2个分支
5. git checkout 可替换命令 git switch 和 git restore
6. 日志规范
在一个团队协作的项目中,开发人员需要经常提交一些代码去修复bug或者实现新的feature。而项目中的文件和实现什么功能、解决什么问题都会渐渐淡忘,最后需要浪费时间去阅读代码。但是好的日志规范commit messages编写有帮助到我们,它也反映了一个开发人员是否是良好的协作者。
6.1. 编写良好的Commit messages可以达到3个重要的目的
- 加快review的流程
- 帮助我们编写良好的版本发布日志
- 让之后的维护者了解代码里出现特定变化和feature被添加的原因
6.2. Commit message 的格式说明
- 目前,社区有多种 Commit message 的写法规范。来自Angular 规范是目前使用最广的写法,比较合理和系统化
7. 依托github创建多分支项目
7.1. master部分操作
- 创建远程仓库
- 创建与远程库一样的项目文件夹
mkdir data_structure_repository
,初始化本地仓库git init
,配置用户名和邮箱 - 关联远程库
git remote add origin git@github.com:fanjianhai/data_structure_repository.git
- 检出本地master分支
git checkout master
7.2. slave部分操作
- 克隆项目(不需要创建文件夹,直接克隆就可以)
git clone git@github.com:fanjianhai/data_structure_repository.git
- 修改配置