学习
贡献指南
Contributing Guide

为 Rooch 做出贡献

感谢您有兴趣为 Rooch 做出贡献！做出贡献的方式有很多种，我们感谢所有这些方式。

通过 GitHub 来贡献

为 Rooch 源代码或文档做出贡献，您需要拥有一个 GitHub 帐户。

提交 PR 的方式通常有两种：

  • 一种是直接在 GitHub 网站上的仓库里进行编辑，提交更改后，直接推送到主分支上。这种方式特别适合提交修改错别字等简单的 PR，对于涉及多个文件或者更改的内容比较多时，不推荐使用这种方式。
  • 另一种方式是，将 Rooch 的仓库 fork 到您自己的账户下，并将其 clone 到本地，完成修改后再将其推送到上游 main 分支（指 Rooch 组织），您自己 GitHub 上的分支称为远程分支。

方式二的详细操作流程

创建一个新分支

首先，在您自己的帐户中创建 rooch 仓库的分支，以便您可以使用自己的副本。

  1. 登录您的 Github 帐户。
  2. 浏览 GitHub 上的 Rooch 存储库 (opens in a new tab)。
  3. 选择右上角的 Fork，然后选择 Create a new fork。
  4. 对于所有者，选择您的用户名。
  5. 对于存储库名称，我们建议保留名称 rooch，但您可以使用任何名称。
  6. 可选。要做出贡献，您只需要存储库的主分支。要包含所有分支，请取消选中仅复制 main 分支的复选框。
  7. 单击 Create fork。

克隆您的分支

接下来，将存储库的分支克隆到本地工作区。

  1. 打开您分支的仓库页面，然后单击 Sync fork 按钮（刚刚拉取出来的分支通常不需要操作，如果你的分支仓库提交落后上游仓库时，才需要同步）。
  2. 单击 Code，然后单击 HTTPS 并复制显示的 Web URL。
  3. 打开终端会话并导航到要使用的文件夹，然后运行以下命令，将 URL 替换为您从 GitHub 页面复制的 URL：
git clone https://github.com/<GITHUB-USER-NAME>/rooch.git

新建分支

克隆完成后，就可以对 rooch 目录内的任意文件进行修改了，默认情况下克隆的是默认分支（可以在 GitHub 设定），通常情况下是 main 分支。

对 Rooch 的项目进行相应的修改前，需要进行最重要的一步：新建主题分支。

通常情况下，不建议您直接使用 main 分支向 Rooch 的上游提交 PR，这不利于 Rooch 的维护者与你进行协作。

新建拉取请求

当你完成了修改，将更改提交并推送到远程仓库后，你通常可以在 GitHub 的页面上看到一个 Compare & pull request 的弹出按钮，点击并填写相应信息即可。

内容通常会自动填充，如果你觉得标题或者这次 PR 的内容描述不够准确，可以继续修改。

修改完成后，点击下方的 Create pull request 按钮后，你的 PR 就会出现在 Rooch 的 Pull requests 页面了。

提交新问题

报告问题和提交特性请求通常在 Issues 页面提交对应的 issue 帖子即可。

当您要报告 Bug 时，请打开 Rooch 的 GitHub Issues 页面 (opens in a new tab)。在上方的搜索栏，简单搜索一下您的问题，可能您发现的问题可能其他人已经提交过了，避免重复提交。如果没有您想报告的 Bug 帖子，此时请点击右上方的 New issue 按钮，输入描述当前 Bug 的简要描述作为标题，并在内容框里填写当前 Bug 的详细描述，包括您的操作（系统）环境，使用的 Rooch 版本以及复现问题的流程等。

当您要请求一个新特性时，在当前的 Issues 页面标题栏上填写特性的简介描述作为标题，并在标题前加上 [Feature Request] 作为标识。

填写好相关信息后，点击右侧的 Lables，打上相应的标签，并点击下方的 Submit new issue 按钮。

Q&AGenesis