Git 使用规范

2. 分支管理规范
2.1 分支说明和操作
master 分支
主分支,永远处于稳定状态,对应当前线上版本
以 tag 标记一个版本,因此在 master 分支上看到的每一个 tag 都应该对应一个线上版本
不允许在该分支直接提交代码
develop 分支
开发分支,包含了项目最新的功能和代码,所有开发都依赖 develop 分支进行
小的改动可以直接在 develop 分支进行,改动较多时切出新的 feature 分支进行
注: 更好的做法是 develop 分支作为开发的主分支,也不允许直接提交代码。小改动也应该以 feature 分支提 merge request 合并,目的是保证每个改动都经过了强制代码 review,降低代码风险
feature 分支
功能分支,开发新功能的分支
开发新的功能或者改动较大的调整,从 develop 分支切换出 feature 分支,分支名称为 feature/xxx
开发完成后合并回 develop 分支并且删除该 feature/xxx 分支
release 分支
发布分支,新功能合并到 develop 分支,准备发布新版本时使用的分支
当 develop 分支完成功能合并和部分 bug fix,准备发布新版本时,切出一个 release 分支,来做发布前的准备,分支名约定为release/xxx
发布之前发现的 bug 就直接在这个分支上修复,确定准备发版本就合并到 master 分支,完成发布,同时合并到 develop 分支
hotfix 分支
紧急修复线上 bug 分支
当线上版本出现 bug 时,从 master 分支切出一个 hotfix/xxx 分支,完成 bug 修复,然后将 hotfix/xxx 合并到 master 和 develop 分支(如果此时存在 release 分支,则应该合并到 release 分支),合并完成后删除该 hotfix/xxx 分支
以上就是在项目中应该出现的分支以及每个分支功能的说明。 其中稳定长期存在的分支只有 master 和 develop 分支,别的分支在完成对应的使命之后都会合并到这两个分支然后被删除。简单总结如下:
master 分支: 线上稳定版本分支
develop 分支: 开发分支,衍生出 feature 分支和 release 分支
release 分支: 发布分支,准备待发布版本的分支,存在多个,版本发布之后删除
feature 分支: 功能分支,完成特定功能开发的分支,存在多个,功能合并之后删除
hotfix 分支: 紧急热修复分支,存在多个,紧急版本发布之后删除
2.2 分支间操作注意事项
在团队开发过程中,避免不了和其他人一起协作, 同时也会遇到合并分支等一些操作,这里提交 2 个个人觉得比较好的分支操作规范。
同一分支 git pull 使用 rebase
首先看一张图:
看到这样的 提交线图,想从中看出一条清晰的提交线几乎是不可能的,充满了 Merge remote-tracking branch 'origin/xxx' into xxx 这样的提交记录,同时也将提交线弄成了交错纵横的图,没有了可读性。
这里最大的原因就是因为默认的 git pull 使用的是 merge 行为,当你更新代码时,如果本地存在未推送到远程的提交,就会产生一个这样的 merge 提交记录。因此在同一个分支上更新代码时推荐使用 git pull --rebase。
下面这张图展示了默认的 git pull 和 git pull --rebase 的结果差异,使用 git pull --rebase 目的是修整提交线图,使其形成一条直线。
默认的 git pull 行为是 merge,可以进行如下设置修改默认的 git pull 行为:
# 为某个分支单独设置,这里是设置 dev 分支
git config branch.dev.rebase true
# 全局设置,所有的分支 git pull 均使用 --rebase
git config --global pull.rebase true
git config --global branch.autoSetupRebase always
这里需要说明一下,在我看来使用 git pull --rebase 操作是比较好的,能够得到一条很清晰的提交直线图,方便查看提交记录和 code review,但是由于 rebase 会改变提交历史,也存在一些不好的影响。这里就不做过多的讨论了,有兴趣的话可以移步知乎上的讨论:在开发过程中使用 git rebase 还是 git merge,优缺点分别是什么?
分支合并使用 --no-ff
# 例如当前在 develop 分支,需要合并 feature/xxx 分支
git merge --no-ff feature/xxx
在解释这个命令之前,先解释下 Git 中的 fast-forward: 举例来说,开发一直在 develop 分支进行,此时有个新功能需要开发,新建一个 feature/a 分支,并在其上进行一系列开发和提交。当完成功能开发时,此时回到 develop 分支,此时 develop 分支在创建 feature/a 分支之后没有产生任何的 commit,那么此时的合并就叫做 fast-forward。
fast-forward 合并的结果如下图所示,这种 merge 的结果就是一条直线了,无法明确看到切出一个新的 feature 分支,并完成了一个新的功能开发,因此此时比较推荐使用 git merge --no-ff,得到的结果就很明确知道,新的一系列提交是完成了一个新的功能,如果需要对这个功能进行 code review,那么只需要检视叉的那条线上的提交即可。
关于以上两个分支间的操作建议,如果需要了解更多,可以阅读洁癖者用 Git:pull --rebase 和 merge --no-ff 这篇文章。
2.3 项目分支操作流程示例
这部分内容结合日常项目的开发流程,涉及到开发新功能、分支合并、发布新版本以及发布紧急修复版本等操作,展示常用的命令和操作。
切到 develop 分支,更新 develop 最新代码
git checkout develop
git pull --rebase
新建 feature 分支,开发新功能
git checkout -b feature/xxx
...
git add
git commit -m "feat(xxx): commit a"
git commit -m "feat(xxx): commit b"
# 其他提交
...
如果此时 develop 分支有一笔提交,影响到你的 feature 开发,可以 rebase develop 分支,前提是 该 feature 分支只有你自己一个在开发,如果多人都在该分支,需要进行协调:
# 切换到 develop 分支并更新 develop 分支代码
git checkout develop
git pull --rebase
# 切回 feature 分支
git checkout feature/xxx
git rebase develop
# 如果需要提交到远端,且之前已经提交到远端,此时需要强推(强推需慎重!)
git push --force
上述场景也可以通过 git cherry-pick 来实现,有兴趣的可以去了解一下这个指令。
完成 feature 分支,合并到 develop 分支
# 切到 develop 分支,更新下代码
git check develop
git pull --rebase
# 合并 feature 分支
git merge feature/xxx --no-ff
# 删除 feature 分支
git branch -d feature/xxx
【Git 使用规范】# 推到远端
git push origin develop
当某个版本所有的 feature 分支均合并到 develop 分支,就可以切出 release 分支,准备发布新版本,提交测试并进行 bug fix

    推荐阅读