Skip to main content

Branch 规范

目标

统一社区和开发者代码库的分支管理。

代码仓库

社区仓库

由社区成员在github上创建的代码仓库。这个仓库只维护main分支和定期发布的tag分支。tag分支命名: v<主版本>.<次版本>.<修订>

个人仓库

登陆github,访问社区代码仓库并fork到个人账户下的仓库。通常也只维护main分支,开发者可以根据自己的习惯创建开发分支,最终这些代码测试稳定后,先合并到个人仓库的mian分支。

分支管理

社区只规定了个人仓库的main分支、社区仓库的main分支、社区仓库的tag分支的管理办法。

个人仓库的main分支

  • 开发者需要定期通过社区仓库的main分支,确保个人仓库的代码始终保持最新,避免后续合并冲突等风险;
  • 开发者的新代码需要先合并到个人仓库的main分支,然后提交pr合并到社区仓库

社区仓库的main分支

  • 正常不允许直接提交代码到main分支,只接受来自开发者个人仓库的main分支合并请求不允许直接提交代码到社区仓库的main分支,只接受来自开发者个人仓库main分支的合并请求

社区仓库的tag分支

  • 每次新建tag分支意味着发布新的版本,需要制作镜像和相关安装包,更新可能的接口文档,还有详细的changelog说明。