开始

轻微修复

对于拼写错误、排版、语法、拼写、标点符号错误，以及其他发生在单个文件内的类似问题或改动，可以直接在当前浏览的页面上进行编辑。当在 kyuubi 的 `Github 仓库`_ 上查看源文件时，只需点击 edit icon（编辑图标）或使用键盘快捷键 e，即可打开编辑器。同样地，在 `Read The Docs`_ 平台上查看文件时，点击 suggest edit（建议编辑）按钮也会引导你进入编辑器。这些方法无需搭建任何本地开发环境，便于快速完成修复。

编辑完成后，选择 commit changes（提交更改）选项，按照提供的说明提交 pull request（拉取请求），并等待指定审查者的反馈。

重大修复

对于影响多个文件的重大改动，建议先将仓库克隆到本地开发环境，完成必要的修改，并进行全面测试，然后再提交 pull request。

Fork 仓库

克隆 Fork 出的仓库

克隆该仓库

$ git clone https://github.com/your_username/kyuubi.git

将 your_username 替换为你的 GitHub 用户名。这会在你的机器上创建一个你 fork 出来的仓库的本地副本。如果你在 kyuubi 文件夹中运行 git branch，将会看到 master 分支。

创建新分支

创建一个新分支

$ git checkout -b guide
Switched to a new branch 'guide'

编辑与测试

使用文本编辑器对文档文件进行必要的修改。构建并验证你所做的更改，查看其效果是否良好。

创建 Pull Request

完成修改后，

• 使用以下命令，附上有意义的提交信息来提交这些更改：

commit the changes

$ git commit -m "Description of changes made"

• 使用以下命令将改动推送到你的分叉仓库

push the changes

$ git push origin guide

• 创建 Pull Request，并填写具有描述性的 PR 标题和说明。
• 根据评审意见修改并完善 PR

仅提交报告

如果你没有时间自行修复文档问题并提交 Pull Request，报告一个文档问题同样很有帮助。请遵循以下基本规则：

• 使用标题字段清楚地描述该问题
• 选择文档报告模板
• 填写文档报告中的必填字段