From ea09047a0615b80ff1b9900a37a9d7afc6a2e1fc Mon Sep 17 00:00:00 2001 From: jonymrshi Date: Mon, 30 Oct 2017 13:51:10 +0800 Subject: [PATCH] doc update --- 组件版本及分支管理.md | 36 ++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/组件版本及分支管理.md b/组件版本及分支管理.md index 5d62174..91a1028 100644 --- a/组件版本及分支管理.md +++ b/组件版本及分支管理.md @@ -1,25 +1,27 @@ + # 组件分支和版本管理 ### 组件分支管理 -- master分支，当前发布tinper-bee的依赖版本分支 -- release分支，是组件当前发布到npm上的最新版本分支 -- develop分支，是基于release分支切出来的分支，是组件开发分支 -- bugfix分支，是基于master分支切出来的分支，用于bug修改 +- master分支，npm、github、tinper-bee 均为无bug的最新代码。 +- develop/x.x.x 分支。 格式为:develop/当前版本号，用于组件功能添加、升级、文档处理等。是基于master切出来的分支。 +- bugfix/issues 分支。 格式为:bugfix/issues 编号，针对issues的bugfix的解决，是基于master分支切出来的分支，用于bug修改 -### 组件版本管理 +### 组件版本号规则 -版本号由三位数字组成，如1.2.3。 -第一位，做了不兼容旧版修改时，修改这一位 -第二位，做了兼容的新功能增强，修改这一位 -第三位，做了当前版微调和bug修改，修改这一位 -组件日常维护两个版本： -一个是tinper-bee组件库依赖版本，锁定发布时的版本号的前两位，修改bug时更改第三位。 -另一个是当前npm发布的新版，包含一些新开发功能或是其他，这时修改版本号后两位，第一位不变。 +1、版本号从0.0.1开始起。 +2、如果有做了不兼容旧版修改时，且组件的全量变更修改。需要升级第一位【eg： 1.x.x】 +3、小功能迭代以及bugfix，只需要不断的增加最后一位即可。【eg ： 0.0.1】 -### 操作细则 + * 如有大的版本号的变更，需要check，在升级提交。 -组件在develop分支开发，开发完成，及测试用例补全及测试通过，文档完善后， -合并到release分支，并发布npm包，在tinper-bee组件库统一发版时，将tinper-bee依赖 -的版本，合并到master分支，并对之前master分支版本打tag。 -当需要bug修改时，在master上切一个bugfix分支，在这个分支上修改，验证通过后，合并回master分支，并发布新的npm包 +### 组件开发/提交流程 + +1、clone 代码。【eg : git clone xx】 +2、根据需求确认分支，然后切换分支。【eg : git checkout -b xx/xx】 +3、在分支开发，开发完毕，后自测无bug的情况下。 +4、review下代码思路以及实现方式。【eg : xx 组员 eg 博宇】 +5、review 完毕代码，切换到master进行代码合并。【git checkout master / git merge xx/xx 】 +6、打包编译，进行发布。【次步骤后续需要配合changelog使用】 + +以上git commit -m " xx "  操作需要替换，生成changelog 的md文件【稍后完善changelog的集成文档】。