Pull Request (PR) 发布指南

本文档详细介绍如何在 GitHub 网页端进行内容修改，并通过发布 Pull Request（PR）将更改内容合并到目标仓库中

发布流程

内容修改

第一步在仓库中找到想要修改的文件位置，这里我们将以/docs/zhHans/guide文件夹为例进行演示。进入目标文件夹后，点击右上方的Add file按钮，选择Create new file选项

此时页面跳转至文件编辑器页面。在上方输入框中输入想要创建的文件名称，并在下方文件编辑器内开始编辑文件内容。

如果需要对仓库中已有文件进行编辑，可以进入目标文件，点击右上方铅笔图标Edit this file进行编辑

在编辑过程中可以随时通过编辑器中的Preview按钮来预览文件效果

提交内容

当我们完成文件内容编辑后，点击窗口右上方的Commit changes...按钮。

此时页面中会弹出一个对话框，要求填写提交信息。我们在第一个输入框中填写简短的提交信息，概括所做的修改。在第二个输入框中更为详细的描述，这部分内容为选填内容。

之后在下方选择提交的分支(branch)，如果你还没有创建本次内容更新的分支，可以在下方输入框中填写一个分支名称。填写完成后点击Propose changes按钮，系统会自动跳转至Pull Request发布页

发布PR

在 PR 发布页中，首先填写一个 title 作为本次 PR 的标题，并在描述框中根据模版详细说明本次修改的内容，例如为什么需要这个修改，修改的具体内容等。这里可以关联相关 issue 链接，方便 reviewer 更好的理解本次修改。模版中可以选择本次变更的类型、内容等信息，选择的方式为将括号中的空格替换为x。