From 47c4484dd14be0eb18cc9e1ccd2b94a1f012c141 Mon Sep 17 00:00:00 2001 From: livc Date: Wed, 26 Apr 2017 21:24:57 +0800 Subject: [PATCH] update doc as comments --- doc/howto/dev/contribute_to_paddle_cn.md | 104 +++++++++++++++-------- 1 file changed, 69 insertions(+), 35 deletions(-) diff --git a/doc/howto/dev/contribute_to_paddle_cn.md b/doc/howto/dev/contribute_to_paddle_cn.md index c95d034c9..64227352c 100644 --- a/doc/howto/dev/contribute_to_paddle_cn.md +++ b/doc/howto/dev/contribute_to_paddle_cn.md @@ -3,8 +3,8 @@ 我们真诚地感谢您的贡献，欢迎通过 GitHub 的 fork 和 pull request 流程来提交代码。 ## 代码要求 -- 你的代码必须完全遵守 [doxygen](http://www.stack.nl/~dimitri/doxygen/) 的样式。 -- 确保编译器选项 WITH\_STYLE\_CHECK 已打开，并且编译能通过代码样式检查。 +- 代码注释请遵守 [Doxygen](http://www.stack.nl/~dimitri/doxygen/) 的样式。 +- 确保编译器选项 `WITH_STYLE_CHECK` 已打开，并且编译能通过代码样式检查。 - 所有代码必须具有单元测试。 - 通过所有单元测试。 @@ -15,7 +15,7 @@ ## 克隆（Clone） -将远程仓库 clone 到本地。 +将远程仓库 clone 到本地： ```bash ➜ git clone https://github.com/USERNAME/Paddle @@ -25,25 +25,30 @@ ## 创建本地分支 -Paddle 目前使用[Git流分支模型](http://nvie.com/posts/a-successful-git-branching-model/)进行开发，测试，发行和维护。**develop** 是主分支，其他用户分支是特征分支（feature branches）。 +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-分支规范)。 所有的 feature 和 bug fix 的开发工作都应该在一个新的分支上完成，一般从 `develop` 分支上创建新分支。 -```bash -# （从当前分支）创建名为 MY_COOL_STUFF_BRANCH 的新分支 -➜ git branch MY_COOL_STUFF_BRANCH +使用 `git checkout -b` 创建并切换到新分支。 -# 切换到这个分支上 -➜ git checkout MY_COOL_STUFF_BRANCH +```bash +➜ git checkout -b my-cool-stuff ``` -也可以通过 `git checkout -b` 一次性创建并切换分支。 +值得注意的是，在 checkout 之前，需要保持当前分支目录 clean，否则会把 untracked 的文件也带到新分支上，这可以通过 `git status` 查看。 + +## 使用 `pre-commit` 钩子 + +Paddle 开发人员使用 [pre-commit](http://pre-commit.com/) 工具来管理 Git 预提交钩子。 它可以帮助我们格式化源代码（C++，Python），在提交（commit）前自动检查一些基本事宜（如每个文件只有一个 EOL，Git 中不要添加大文件等）。 + +`pre-commit`测试是 Travis-CI 中单元测试的一部分，不满足钩子的 PR 不能被提交到 Paddle，首先安装并在当前目录运行它： ```bash -➜ git checkout -b MY_COOL_STUFF_BRANCH +➜ pip install pre-commit +➜ pre-commit install ``` -值得注意的是，在 checkout 之前，需要保持当前分支目录 clean，否则会把 untracked 的文件也带到新分支上，这可以通过 `git status` 查看。 +Paddle 使用 `clang-format` 来调整 C/C++ 源代码格式，请确保 `clang-format` 版本在 3.8 以上。 ## 开始开发 @@ -68,6 +73,36 @@ Untracked files: no changes added to commit (use "git add" and/or "git commit -a") ``` +## 构建和测试 + +编译 PaddlePaddle 的源码以及生成文档需要多种开发工具。为了方便大家，我们的标准开发流程是把这些工具都装进一个Docker image，称为*开发镜像*，通常名字是 `paddle:dev`。然后所有用 `cmake && make` 的地方（比如IDE配置里）都用 `docker run paddle:dev`来代替。 + +如要build这个开发镜像，在源码目录树的根目录中运行： + +```bash +➜ docker build -t paddle:dev . +``` + +随后可以用这个开发镜像开build PaddlePaddle的源码。比如如果要build一个不依赖GPU，但是支持AVX指令集，并且包括unit tests的PaddlePaddle，可以： + +```bash +➜ docker run -v $(pwd):/paddle -e "WITH_GPU=OFF" -e "WITH_AVX=ON" -e "WITH_TEST=ON" paddle:dev +``` + +这个过程除了编译PaddlePaddle为 `./build/libpaddle.so`，并且输出一个 `./build/paddle.deb`文件之外，还会输出一个 `build/Dockerfile`。我们只需要运行下面命令把编译好的PaddlePaddle打包成一个*生产镜像*（`paddle:prod`）： + +```bash +➜ docker build -t paddle:prod -f build/Dockerfile . +``` + +如果要运行所有的单元测试，可以用如下命令： + +```bash +➜ docker run -it -v $(pwd):/paddle paddle:dev bash -c "cd /paddle/build && ctest" +``` + +关于构建和测试的更多信息，请参见[这篇文档](https://github.com/PaddlePaddle/Paddle/blob/develop/doc/getstarted/build_and_install/docker_install_cn.rst)。 + ## 提交（commit） 接下来我们取消对 README.md 文件的改变，然后提交新添加的 test 文件。 @@ -85,17 +120,10 @@ nothing added to commit but untracked files present (use "git add" to track) ➜ git add test ``` -Paddle 使用 [pre-commit](http://pre-commit.com) 完成代码风格检查的自动化，它会在每次 commit 时自动检查代码是否符合规范，并检查一些基本事宜，因此我们首先安装并在当前目录运行它。 +Git 每次提交代码，都需要写提交说明，这可以让其他人知道这次提交做了哪些改变，这可以通过`git commit` 完成。 ```bash -➜ pip install pre-commit -➜ pre-commit install -``` - -Git 每次提交代码，都需要写提交说明，这可以让其他人知道这次提交做了哪些改变，这可以通过`git commit -m` 完成。 - -```bash -➜ git commit -m "add test file" +➜ git commit CRLF end-lines remover...............................(no files to check)Skipped yapf.................................................(no files to check)Skipped Check for added large files..............................................Passed @@ -104,7 +132,7 @@ Check for broken symlinks................................................Passed Detect Private Key...................................(no files to check)Skipped Fix End of Files.....................................(no files to check)Skipped clang-formater.......................................(no files to check)Skipped -[MY_COOL_STUFF_BRANCH c703c041] add test file +[my-cool-stuff c703c041] add test file 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 233 ``` @@ -136,7 +164,7 @@ upstream ```bash ➜ git fetch upstream -➜ git pull --rebase upstream develop +➜ git pull upstream develop ``` ## Push 到远程仓库 @@ -144,23 +172,23 @@ upstream 将本地的修改推送到 GitHub 上，也就是 https://github.com/USERNAME/Paddle。 ```bash -# 推送到远程仓库 origin 的 MY_COOL_STUFF_BRANCH 分支上 -➜ git push origin MY_COOL_STUFF_BRANCH +# 推送到远程仓库 origin 的 my-cool-stuff 分支上 +➜ git push origin my-cool-stuff ``` -## 建立 Issue 并完成 PR +## 建立 Issue 并完成 Pull Request -建立一个 Issue 描述问题，记录它的编号。 +建立一个 Issue 描述问题，并记录它的编号。 -在 Push 新分支后， https://github.com/USERNAME/Paddle 中会出现新分支提示，点击绿色按钮发起 PR。 +切换到所建分支，然后点击 `New pull request`。 -![](https://ws1.sinaimg.cn/large/9cd77f2egy1fez1jq9mwdj21js04yq3m.jpg) +screen shot 2017-04-26 at 9 09 28 pm 选择目标分支： -![](https://ws1.sinaimg.cn/large/9cd77f2egy1fez1ku4a5vj21am04st9l.jpg) +screen shot 2017-04-26 at 9 11 52 pm -在 PR 的说明中，填写 `solve #Issue编号` 可以在这个 PR 被 merge 后，自动关闭对应的 Issue，具体请见 。 +在 PR 的描述说明中，填写 `solve #Issue编号` 可以在这个 PR 被 merge 后，自动关闭对应的 Issue，具体请见 。 接下来等待 review，如果有需要修改的地方，参照上述步骤更新 origin 中的对应分支即可。 @@ -168,7 +196,13 @@ upstream 在 PR 被 merge 进主仓库后，我们可以在 PR 的页面删除远程仓库的分支。 -![](https://ws1.sinaimg.cn/large/9cd77f2egy1fez1pkqohzj217q05c0tk.jpg) +screen shot 2017-04-26 at 9 18 24 pm + +也可以使用 `git push origin :分支名` 删除远程分支，如： + +```bash +➜ git push origin :my-cool-stuff +``` ## 删除本地分支 @@ -176,10 +210,10 @@ upstream ```bash # 切换到 develop 分支 -git checkout develop +➜ git checkout develop -# 删除 MY_COOL_STUFF_BRANCH 分支 -git branch -D MY_COOL_STUFF_BRANCH +# 删除 my-cool-stuff 分支 +➜ git branch -D my-cool-stuff ``` 至此，我们就完成了一次代码贡献的过程。 -- GitLab