Paddle发行规范¶

Paddle使用git-flow branching model做分支管理，使用Semantic Versioning标准表示Paddle版本号。

Paddle每次发新的版本，遵循以下流程:

从develop分支派生出新的分支，分支名为release/版本号。例如，release/0.10.0
将新分支的版本打上tag，tag为版本号rc.Patch号。第一个tag为0.10.0rc1，第二个为0.10.0rc2，依次类推。
对这个版本的提交，做如下几个操作:
- 编译这个版本的Docker发行镜像，发布到dockerhub。如果失败，修复Docker编译镜像问题，Patch号加一，返回第二步
- 编译这个版本的Ubuntu Deb包。如果失败，修复Ubuntu Deb包编译问题，Patch号加一，返回第二步。
- 使用Regression Test List作为检查列表，测试Docker镜像/ubuntu安装包的功能正确性
  - 如果失败，记录下所有失败的例子，在这个release/版本号分支中，修复所有bug后，Patch号加一，返回第二步
第三步完成后，将release/版本号分支合入master分支，并删除release/版本号分支。将master分支的合入commit打上tag，tag为版本号。同时再将master分支合入develop分支。最后删除release/版本号分支。
编译master分支的Docker发行镜像，发布到dockerhub。编译ubuntu的deb包，发布到github release页面
协同完成Release Note的书写

需要注意的是:

release/版本号分支一旦建立，一般不允许再从develop分支合入release/版本号。这样保证release/版本号分支功能的封闭，方便测试人员测试Paddle的行为。
在release/版本号分支存在的时候，如果有bugfix的行为，需要将bugfix的分支同时merge到master, develop和release/版本号这三个分支。

Paddle 分支规范¶

Paddle开发过程使用git-flow分支规范，并适应github的特性做了一些区别。

Paddle的主版本库遵循git-flow分支规范。其中:
- master分支为稳定(stable branch)版本分支。每一个master分支的版本都是经过单元测试和回归测试的版本。
- develop分支为开发(develop branch)版本分支。每一个develop分支的版本都经过单元测试，但并没有经过回归测试。
- release/版本号分支为每一次Release时建立的临时分支。在这个阶段的代码正在经历回归测试。
其他用户的fork版本库并不需要严格遵守git-flow分支规范，但所有fork的版本库的所有分支都相当于特性分支。
- 建议，开发者fork的版本库使用develop分支同步主版本库的develop分支
- 建议，开发者fork的版本库中，再基于develop版本fork出自己的功能分支。
- 当功能分支开发完毕后，向Paddle的主版本库提交Pull Reuqest，进而进行代码评审。
  - 在评审过程中，开发者修改自己的代码，可以继续在自己的功能分支提交代码。
BugFix分支也是在开发者自己的fork版本库维护，与功能分支不同的是，BugFix分支需要分别给主版本库的master、develop与可能有的release/版本号分支，同时提起Pull Request。

本列表说明Paddle发版之前需要测试的功能点。

Paddle每次发版本首先要保证Paddle Book中所有章节功能的正确性。功能的正确性包括验证Paddle目前的paddle_trainer训练和纯使用Python训练模型正确性。