Architecture►第三章：基础规范

分支规范

[toc]

分支规范

一、分支简介

项目应包含以下分支：

  1. master

    该分支为项目主分支，此分支只作为稳定版本发布使用，不允许在此分支上修改 bug ，开发功能等。并且该分支每次发布时需根据项目的版本号打上 tag ，例如 v1.0.0。

  2. develop

    该分支为各开发人员的开发合并分支，各开发人员在各自开发分支/功能分支/bug分支上开发/调试代码，完成相关工作后即可合并到 develop 分支，不允许各位在此分支上直接开发。此分支无需打 tag 。

  3. qa-test

    该分支是交由 QA 进行测试的分支，每次交由 QA 测试时，从 dev 分支合并到该分支，合并的最后一次 commit 需要打 tag ，例如 v1.0.0-test-num，num 为 1.0.0 版本提交测试的序号。QA 测试稳定后，merge 到 master 并打上 tag，待发布。

  4. feture_xxx

    该分支用于开发新功能，比如新版本迭代时，有一个较大的功能模块，可以不在 dev_hzxxx 分支开发，相关开发同学可在此类分支上开发，有两个优点：(1)可以多人协同 (2)可以防止模块较大时导致原来代码混乱。

  5. issue_xxx

    该分支用于解决 jira 上 bug，修改完成并验证后合并到 dev 分支，等待 QA 验证。

说明：关于以上 feature_xxx 和 issue_xxx 分支的使用说明可以根据实际情况进行参考，不是规定死的，在开发过程中有疑问可以跟大家讨论。

二、分支命名规范

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
master

develop

分支命名方式：模块/基础_功能_开发者
形如：
feature：新功能（feature）。
-------feature/auth
-------feature/auth_normal
-------feature/auth_ban
-------feature/auth_ban_qian
perf：优化相关，比如提升性能、体验。
-------perf/apm
-------perf/apm_dokit
chore：构建过程或辅助工具的变动。
-------chore/pack

附1：已知模块选项如下：
"strong_business": {
	"auth": "登录模块(登录/注册、退出)",
	"profile": "用户模块(个人首页/个人中心)",
	"member": "会员模块(会员中心)",
	"wish": "愿望单模块(愿望单列表、愿望单详情)",
	"mall": "商城模块(商城首页、商品详情)",
	"publish": "发布模块(愿望单发布)",
	"order": "订单模块(订单列表、订单详情)",
	"search": "搜索模块(大搜索)",
	"im": "IM模块（会话列表、会话窗口）",
	"live": "直播模块",
	"comment": "评论模块"
}

附2：已知基础选项：
"package": {
	"network": "网络模块",
	"route": "路由模块",
	"webview": "网页模块(js)",
	"version": "版本模块（版本检查(含蒲公英)、应用内下载）",
	"location": "定位模块",
	"media": "媒体模块（选择、编辑、降噪增益）",
	"share": "分享模块",
	"apm": "应用性能管理(dokit、)",
	"package": "其他基础库"
}