diff --git a/doc/fluid/advanced_usage/development/contribute_to_paddle/img/paddle_ci_log.png b/doc/fluid/advanced_usage/development/contribute_to_paddle/img/paddle_ci_log.png new file mode 100644 index 0000000000000000000000000000000000000000..16087ce059aa3c07ce8c927d983eb86351915825 Binary files /dev/null and b/doc/fluid/advanced_usage/development/contribute_to_paddle/img/paddle_ci_log.png differ diff --git a/doc/fluid/advanced_usage/development/contribute_to_paddle/local_dev_guide.md b/doc/fluid/advanced_usage/development/contribute_to_paddle/local_dev_guide.md index c239e4e31631546991d3099cba160902e1e04661..6a6a9027972bb9235de6eef145378b53e4a8cbcc 100644 --- a/doc/fluid/advanced_usage/development/contribute_to_paddle/local_dev_guide.md +++ b/doc/fluid/advanced_usage/development/contribute_to_paddle/local_dev_guide.md @@ -26,7 +26,7 @@ ## 创建本地分支 -Paddle 目前使用[Git流分支模型](http://nvie.com/posts/a-successful-git-branching-model/)进行开发,测试,发行和维护,具体请参考 [Paddle 分支规范](https://github.com/PaddlePaddle/Paddle/blob/develop/doc/design/releasing_process.md#paddle-分支规范)。 +Paddle 目前使用[Git流分支模型](http://nvie.com/posts/a-successful-git-branching-model/)进行开发,测试,发行和维护,具体请参考 [Paddle 分支规范](https://github.com/PaddlePaddle/FluidDoc/tree/develop/doc/fluid/design/others/releasing_process.md)。 所有的 feature 和 bug fix 的开发工作都应该在一个新的分支上完成,一般从 `develop` 分支上创建新分支。 @@ -110,7 +110,11 @@ no changes added to commit (use "git add" and/or "git commit -a") ➜ docker run -it -v $(pwd):/paddle paddle:latest-dev bash -c "cd /paddle/build && ctest" ``` -关于构建和测试的更多信息,请参见[使用Docker安装运行](https://github.com/PaddlePaddle/Paddle/blob/develop/doc/v2/build_and_install/docker_install_cn.rst)。 +关于构建和测试的更多信息,请根据您的系统环境查看Docker安装教程: + +- [Ubuntu](../../../beginners_guide/install/install_Ubuntu.html#permalink-4--docker-) +- [CentOS](../../../beginners_guide/install/install_CentOS.html#permalink-4--docker-) +- [MacOS](../../../beginners_guide/install/install_MacOS.html#permalink-4--docker-) ## 提交(commit) @@ -150,10 +154,10 @@ clang-formater.......................................(no files to check)Skipped ```bash # 触发develop分支的CI单测 -➜ git commit -m "test=develop" +➜ git commit -m "this is an example, test=develop" -# 触发release/1.1分支的CI单侧 -➜ git commit -m "test=release/1.1" +# 触发release/1.1分支的CI单测 +➜ git commit -m "this is an example, test=release/1.1" ``` ## 保持本地仓库最新 diff --git a/doc/fluid/advanced_usage/development/contribute_to_paddle/submit_pr_guide.md b/doc/fluid/advanced_usage/development/contribute_to_paddle/submit_pr_guide.md index 98d042776c2af4b43317667b9324fb15248122c7..5d0bc405c53b772ca5f7a53d3679f76b87a325a1 100644 --- a/doc/fluid/advanced_usage/development/contribute_to_paddle/submit_pr_guide.md +++ b/doc/fluid/advanced_usage/development/contribute_to_paddle/submit_pr_guide.md @@ -26,7 +26,7 @@
- +
@@ -34,7 +34,7 @@
- +
@@ -43,14 +43,27 @@ 您在Pull Request中每提交一次新的commit后,会触发CI单元测试,请确认您的commit message中已加入必要的说明,请见[提交(commit)](local_dev_guide.html#permalink-8--commit-) -请您关注您Pull Request中的CI单元测试进程,它将会在几个小时内完成 +- 请您关注您Pull Request中的CI单元测试进程,它将会在几个小时内完成 -您仅需要关注和自己提交的分支相关的CI项目,例如您向develop分支提交代码,则无需关注release/1.1一栏是否通过测试 +- 您仅需要关注和自己提交的分支相关的CI项目,例如您向develop分支提交代码,则无需关注release/1.1一栏是否通过测试 -当所需的测试后都出现了绿色的对勾,表示您本次commit通过了各项单元测试 +- 当所需的测试后都出现了绿色的对勾,表示您本次commit通过了各项单元测试 -如果所需的测试后出现了红色叉号,代表您本次的commit未通过某项单元测试,在这种情况下,请您点击detail查看报错详情,并将报错原因截图,以评论的方式添加在您的Pull Request中,我们的工作人员将帮您查看 +- 如果所需的测试后出现了红色叉号,代表您本次的commit未通过某项单元测试,请您按照以下步骤查看报错信息: +1)点击出现报错的CI测试项栏最右边的“detail” + +2)如果您未登陆过CI网站,您会看到一个登陆窗口,此时请您点击“Log in as guest”(如下图),即可查看报错信息 + +
+ + + +
+ + 3)修复与反馈 + + 请您根据报错信息自行修复,如果确定本地commit不会触发报错,则报错可能是由CI不稳定引起的。这种情况下,请将报错详情以评论的方式添加在您的Pull Request中,我们的工作人员将帮您查看,这里提供一个[例子](https://github.com/PaddlePaddle/Paddle/pull/14337#issuecomment-437398972) ## 删除远程分支