本地开发指南

    • 代码注释请遵守 Doxygen 的样式。

    • 确保编译器选项 WITH_STYLE_CHECK 已打开，并且编译能通过代码样式检查。

    • 所有代码必须具有单元测试。

    • 通过所有单元测试。

    以下教程将指导您提交代码。

    Fork

    跳转到 GitHub首页，然后单击 Fork 按钮，生成自己目录下的仓库，比如 https://github.com/USERNAME/Paddle。

    克隆（Clone）

    将远程仓库 clone 到本地：

    所有的 feature 和 bug fix 的开发工作都应该在一个新的分支上完成，一般从 develop 分支上创建新分支。

    使用 git checkout -b 创建并切换到新分支。

    1. ➜  git checkout -b my-cool-stuff

    值得注意的是，在 checkout 之前，需要保持当前分支目录 clean，否则会把 untracked 的文件也带到新分支上，这可以通过 git status 查看。

    使用 pre-commit 钩子

    Paddle 开发人员使用 工具来管理 Git 预提交钩子。 它可以帮助我们格式化源代码（C++，Python），在提交（commit）前自动检查一些基本事宜（如每个文件只有一个 EOL，Git 中不要添加大文件等）。

    pre-commit测试是 Travis-CI 中单元测试的一部分，不满足钩子的 PR 不能被提交到 Paddle，首先安装并在当前目录运行它：

    1. ➜  pip install pre-commit
    2. ➜  pre-commit install

    Paddle 使用 clang-format 来调整 C/C++ 源代码格式，请确保 clang-format 版本在 3.8 以上。

    注：通过pip install pre-commit和conda install -c conda-forge pre-commit安装的yapf稍有不同的，Paddle 开发人员使用的是。

    开始开发

    在本例中，我删除了 README.md 中的一行，并创建了一个新文件。

    关于编译 PaddlePaddle 的源码，请参见 选择对应的操作系统。 关于单元测试，可参考Op单元测试 的运行方法。

    提交（commit）

    接下来我们取消对 README.md 文件的改变，然后提交新添加的 test 文件。

    1. ➜  git checkout -- README.md
    2. ➜  git status
    3. On branch test
    4. Untracked files:
    5.   (use "git add <file>..." to include in what will be committed)
    7.     test
    9. nothing added to commit but untracked files present (use "git add" to track)
    10. ➜  git add test

    Git 每次提交代码，都需要写提交说明，这可以让其他人知道这次提交做了哪些改变，这可以通过git commit 完成。

    1. ➜  git commit
    3. Check for added large files..............................................Passed
    4. Check for merge conflicts................................................Passed
    5. Check for broken symlinks................................................Passed
    6. Detect Private Key...................................(no files to check)Skipped
    7. Fix End of Files.....................................(no files to check)Skipped
    8. clang-formater.......................................(no files to check)Skipped
    9. [my-cool-stuff c703c041] add test file
    10.  1 file changed, 0 insertions(+), 0 deletions(-)
    11.  create mode 100644 233

    保持本地仓库最新

    在准备发起 Pull Request 之前，需要同步原仓库（）最新的代码。

    首先通过 git remote 查看当前远程仓库的名字。

    这里 origin 是我们 clone 的远程仓库的名字，也就是自己用户名下的 Paddle，接下来我们创建一个原始 Paddle 仓库的远程主机，命名为 upstream。

    1. ➜  git remote add upstream https://github.com/PaddlePaddle/Paddle
    2. ➜  git remote
    3. origin
    4. upstream

    获取 upstream 的最新代码并更新当前分支。

    将本地的修改推送到 GitHub 上，也就是 https://github.com/USERNAME/Paddle。