MMSIG 文档贡献指南 (建设中)

给本 MMSIG 贡献者教程贡献的步骤如下：

• Fork 仓库

• 编辑文档

• 创建 PR (Pull Requests)

• OpenMMLab 社区管理员 Merge PR

1. Fork Github 仓库

点击进入https://github.com/open-mmlab/OpenMMLabCamp/tree/mmsig 进入 OpenMMLabCamp 仓库 mmsig 分支，然后点击 Fork。

image

取消勾选 Copy the main branch only，并点击 Create fork。

创建新 fork

这样就把 OpenMMLabCamp 的仓库 Fork 到自己账号下面了，可以看到本教程的演示账号 OpenMMLab-Assistant-004 下面多了一个 OpenMMLabCamp 的 仓库。

image

2. 编辑 markdown 文档

我们点击自己账号中 OpenMMLabCamp 仓库，切换到 mmsig 分支。

image

在 OpenMMLabCamp 的 mmsig 分支找到需要编辑的对应文档，我们点击进行编辑。

image

在 Edit file 中能够编辑 markdown 格式的文档。

image

点击 Preview 能够预览 Markdown 渲染出来的文档。

image

3. 提 PR （Pull Request）

在完成文档的编辑后，我们在底部的 Commit changes 中选择 ** Create a new branch for this commit and start a pull request.**， 并给分支命名,这里命名为 update_mmsig_doc 分支，然后点击 Propose changes

image

点击 compare across forks, 并选择刚刚选择 OpenMMLab-Assistant-004/OpenMMLabCamp中的 update_mmsig_doc 分支 创建 Pull Request 到 open-mmlab/OpenMMLabCamp中的 mmsig 分支，编辑好Pull Request 的标题和详细内容后，点击 Create pull request。

img_v2_cef1434b-45f3-4e2b-ac30-421d81194b9g

此时在浏览器地址栏能得到此 PR 的链接，可以在 PR 链接中追踪状态，并等待 OpenMMLab 社区管理员对 PR 进行 Review 和 Merge。

img_v2_1db926da-0eec-422f-a81d-e906c1e95a5g

如果社区管理员没有直接 merge 而是给出了一下修改建议，请在上文中对应的 OpenMMLab-Assistant-004/OpenMMLabCamp中的 update_mmsig_doc 分支中对应的文档进行修改。

image

修改 PR 中的内容，不需要重新创建新的分支，只需要在原来的 PR 对应的分支上修改内容，并在修改内容后填写 commit changes 的标题和内容，并选择 Commit directly to the update_mmsig_doc branch. 并点击 Commit changes 。此时在 PR 界面出现了 [Fix] fix typo 的记录，我们点击 Resolve conversation。

image

经过和社区管理员的多轮 review 与修改后，PR 就 Merge 了。

image