Java 开发必备 Git 分支开发:规范指南及完全学会 Git 的 24 堂课笔记
分支命名
========
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?de
v?--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 地址或者其它文档
下面给大家分享出来这份大牛力荐的《完全学会 Git GitHub Git Server 的 24 堂课》
.针对项目开发人员:以最有效率的方式,引导你在实践中完整地学习 Git 的操作技巧和应用。
对项目管理者:在实例中学习如何查看项目开发的名种统计图,以便随时掌握项目开发的状况。
针对 MIS 人员:提供建立 Git Server 的多种玩法,自行选用和规划最适合自己实际运用的方法。
内容简介
====
本书以教科书的方式,循序渐进地向软件开发人员或软件开发的项目管理人员,讲述如何快速掌握分布式版本控制系统 Git 的应用方法,让繁琐复杂的项目开发的版本控制变得高效且轻松自如。书中细致入微地介绍了如何使用设置文件和操作 Git 文档库,以及建立项目开发的分支、合并分支和解决冲突的操作:在具备扎实的基础之后,介绍了 Git GUI 程序用法,以及 Git 在团队开发模式中应用的问题:讲述如何与全球的项目开发人员进行交流,提升程序开发的经验和能力:介绍了 GitHub、 Bitbucket、 GitLab 等提供 Git 服务的网站;本书最后的重点为介绍架设 Git Server 的几种方法,让每一个项目开发团队,可以按照自己的软硬件环境,选择适合的方式来控管项目开发。
目录章节展示
======
第一部分 Git 的基本概念和操作
第 1 课 Git、谁与争锋
第 2 课 Gi t 配置文件的妙用
第 3 课把文件存入 Gi t 文档库
第 4 课比较文件的差异和从 Gi t 文档库取回文件
第 5 课 Gi t 程序项目管理的实践演练
第 6 课获取 Git 文档库统计数据和绘制统计图表
第二部分建立分支、合并和解决冲突
第 7 课程序项目的分支(Br anch)
评论