文档贡献指南¶

1.1 Fork¶

先跳转到 PaddlePaddle/docs GitHub 首页，然后单击 Fork 按钮，生成自己仓库下的目录，比如你的 GitHub 用户名为 USERNAME，则生成： https://github.com/USERNAME/docs。

1.2 Clone¶

将你目录下的远程仓库 clone 到本地。

➜ git clone https://github.com/USERNAME/docs
➜ cd docs

1.3 创建本地分支¶

docs 目前使用 Git 流分支模型进行开发，测试，发行和维护。

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

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

➜  git checkout -b my-cool-stuff

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

1.4 安装 pre-commit 工具（若有的话，可以跳过此步骤）¶

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

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

➜  pip install pre-commit==2.17.0
➜  pre-commit install

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

2.1 新增文档¶

当你要新增文档时，需要参考上述的对应关系，找到合适的目录，新建 Markdown 或 reStructuredText 文件。中英文文档存储在同一路径下，其中，中文文档的后缀为 _cn.md/rst，英文文档的后缀为 _en.md/rst。

在新增文件后，还需要在目录文件中添加该文件的索引。目录文件一般是 index_cn.rst/index_en.rst，需要在文件的 .. toctree:: 部分添加该文件的索引。

如在「文档」->「使用教程」->「动态图转静态图」中新增「报错调试」，首先需要在 docs/guides/jit/ 中 新建 debugging_cn.md，debugging_en.md 文件。之后，在 docs/guides/jit/index_cn.rst 的 toctree 部分，新增 debugging_cn.md 的索引，合入后即可展示到官网。

..  toctree::
    :hidden:

    basic_usage_cn.md
    principle_cn.md
    grammar_list_cn.md
    case_analysis_cn.md
    debugging_cn.md      # 新增索引

2.2 修改文档¶

修改文档，可以通过文档的 URL，确定文档的源文件。 如「文档」->「使用教程」->「动态图转静态图」中「报错调试」的文档 URL 为：https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/jit/debugging_cn.html，URL 路径中，guides/jit/debugging_cn.html 即对应 (docs/)guides/jit/debugging_cn.md , 因此，可以很快的确定文档的源文件，然后直接修改即可。

3.1 提交&触发 CI 单测¶

• 修改 docs/guides/jit/debugging_cn.md 这个文件，并提交这个文件

➜  git status
On branch my-cool-stuff
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified:   paddle/tensor/math/all_cn.rst

no changes added to commit (use "git add" and/or "git commit -a")

➜  git add docs/guides/jit/debugging_cn.md

如果你不想提交本次修改，使用 git checkout -- <file> 取消上面对 docs/guides/jit/debugging_cn.md 文件的提交，可以将它恢复至上一次提交的状态:

➜  git checkout -- docs/guides/jit/debugging_cn.md

恢复后重新进行修改并提交文件即可。

• commit ：提交本地更改

每次 git commit 都需要写提交说明，方便其他人了解每次提交做了哪些改变，可以通过 git commit -m <commit_message> 完成。

➜  git commit -m "fix docs bugs"
check for merge conflicts................................................Passed
check for broken symlinks............................(no files to check)Skipped
detect private key.......................................................Passed
fix end of files.........................................................Passed
trim trailing whitespace.................................................Passed
CRLF end-lines remover...................................................Passed
Tabs remover.............................................................Passed
CN-[whitespace]-EN fixer.................................................Passed
convert jinja2 into html.............................(no files to check)Skipped
convert-markdown-into-html...........................(no files to check)Skipped
black................................................(no files to check)Skipped
ruff.................................................(no files to check)Skipped
[my-cool-stuff ee8f4441f] fix docs bugs
 1 file changed, 19 insertions(+), 34 deletions(-)

注意：git commit 执行后会进行代码预检测，不能出现失败的情况，如果有 failed 的检测项需先处理，才能继续后续步骤。

3.2 确保本地仓库是最新的¶

在准备发起 Pull Request 之前，需要同步原仓库（https://github.com/PaddlePaddle/docs）最新的代码。

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

➜  git remote
origin
➜  git remote -v
origin  https://github.com/USERNAME/docs (fetch)
origin  https://github.com/USERNAME/docs (push)

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

➜  git remote add upstream https://github.com/PaddlePaddle/docs
➜  git remote
origin
upstream

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

➜  git fetch upstream
➜  git pull upstream develop

3.3 Push 到远程仓库¶

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

# 推送到远程仓库 origin 的 my-cool-stuff 分支上
➜  git push origin my-cool-stuff