OceanBase 社区从 6月1日 开始了新一期的文档提升计划，我们也称之为“捉虫”，欢迎大家在空闲时间动动小手，帮助我们一起提升文档中存在的问题。本文中总结了一些可能在捉虫过程中遇到的问题，希望能够帮助到大家。如果大家有任何疑问，可以反馈并敦促我完善这篇文章。
Q1：如何查看自己的码云账号？
个人账号常常与 CLA 和本地提交的 Gitee 名称相对应。由于当前 OceanBase 的仓库均托管在 GitHub 上，Gitee 上是与 GitHub 上一模一样的镜像，本次为了方便大家更流畅的进行“捉虫”，采用 Gitee 的方式接受大家的 pr，各种原因 Gitee 上暂时不需要签署 CLA。那么我们要这个账号有啥用？通常最终会用这个账号来统计大家的 pr 提交情况来记分。
A1：您可以按照以下步骤查看自己的码云账号：
-
进入码云官网。https://gitee.com
如果您还没有码云账户，请点击红色框中的[注册Gitee]进行注册。 -
单击右上角“登录”。进入登录页面后，输入用户名和密码。
-
登录成功后，单击页面右上角个人头像，在下拉框中单击“个人主页”。
-
在“个人主页”页面头像下即可查看自己的 Gitee 账号。
Q2：如何配置本地 Git 环境？
A2： 如果您想长期提交 pr，那就需要配置本地 Git 环境，并下载仓库到本地。
-
拉取个人本地分支
在对应的doc仓库右侧单击 Fork 完成个人分支拉取。（我这里以仓库 obd-doc 为例）
完成后的状态如下：
-
安装git
您可以在git官网选择所需git版本下载并安装。 -
配置git
配置git上的user为您的 Gitee 个人名称（Q1中可以获取到个人名称）。git config --global user.name "your gitee name"配置git邮箱为您的 Gitee 注册邮箱。
git config --global user.email "your Gitee email"“your Gitee email” 为 Gitee注册邮箱。您可以在 Gitee 个人主页获取。也就是您的登陆邮箱。
-
克隆上面 Fork 的仓库到本地，例如：
git clone https://gitee.com/chrisyuan/oceanbase-doc.git做上面操作的时候，通常会让您输入 Gitee 密码，此时您输入登录 Gitee 的密码即可。
Q3：如何提交 Pull Request (简称 pr)？
A3： 提交 pr 最基本的逻辑是：在本地做修改，push到自己的仓库，然后再生成 pr 提交到官方仓库。具体步骤如下：
-
Fork 官方仓库（该步骤在上面的问题中已经完成，如果您没有做，请参考下图）
-
将自己 Fork 出来的仓库 clone 到电脑本地：
git clone https://gitee.com/chrisyuan/oceanbase-doc.git (请对应修改地址，别把我的fork到您本地了) -
创建一个新的分支
git checkout -b ob-pr1 (这里我创建了一个新分支 ob-pr1) -
在社区文档上找到问题后，点击文档中的“编辑”按钮：
此时会跳转到一个 Github 地址，无论是否显示页面内容，我们只需要 url 中的部分路径。例如：
https://github.com/oceanbase/obd-doc/edit/V1.3.3/zh-CN/3.user-guide/2.start-the-oceanbase-cluster-by-using-obd.md -
编辑本地的 Gitee 仓库对应目录文件：
例如上面的 url，我们在本地的仓库中，通常是在 zh-CN这个目录下，那么我们截取 zh-CN及之后的内容进行编辑，如下：
vim zh-CN/3.user-guide/2.start-the-oceanbase-cluster-by-using-obd.md编辑完成后，保存退出。
-
将修改完的内容提交到自己的仓库
git add zh-CN/3.user-guide/2.start-the-oceanbase-cluster-by-using-obd.md git commit -m "这次我修改了什么" git push origin ob-pr1 (上面起好的新分支名字) -
向官方仓库提交 pr
选择刚才提交的分支，按照逻辑应该叫 ob-pr1，下图仅供参考
点击 “Pull Request” 按钮
在新出现的 pr 描述界面，写上本次修复的内容（可以复制 git commit 中写的内容），最后点击下面的提交按钮。整个 pr 提交完成 -
切换回主分支并继续步骤 3-7。
Q4：如何提交轻量级 pr ？
A4： 所谓轻量级 pr 就是直接在官方的仓库上面修改。和上面我们 fork 自己的仓库的区别就是不需要一大堆步骤了，只适用于少量修改的场景。
-
在社区文档上找到问题后，点击文档中的“编辑”按钮：
此时会跳转到一个 Github 地址，无论是否显示页面内容，我们只需要 url 中的部分路径。例如：
https://github.com/oceanbase/obd-doc/edit/V1.3.3/zh-CN/3.user-guide/2.start-the-oceanbase-cluster-by-using-obd.md -
打开 Gitee 上的官方仓库，找到对应的文档位置，然后点击编辑按钮，保存修改，就可以了。
