为项目做贡献

了解如何通过 fork 为项目做贡献。

平台导航

本文内容

关于 fork

如果你想为别人的项目做贡献，但没有该仓库的写入权限，可以使用“fork 和拉取请求”工作流程。

Fork 是一个新的仓库，它与原始的“上游”仓库共享代码和可见性设置。Fork 通常用于在将想法或更改提议回上游仓库之前进行迭代，例如在开源项目中，或者当用户没有上游仓库的写入权限时。

你可以通过从你的 fork 向上游仓库提交拉取请求来做出贡献。有关更多信息，请参阅“Fork 仓库”。

Fork 仓库

本教程使用 Spoon-Knife 项目，这是一个托管在 GitHub.com 上的测试仓库，可用于测试 fork 和 pull request 工作流程。

  1. 导航到 https://github.com/octocat/Spoon-Knife 上的 Spoon-Knife 项目。

  2. 在页面右上角，点击 **Fork**。

    Screenshot of the main page of repository. A button, labeled with a fork icon and "Fork 59.3k," is outlined in dark orange.

  3. 在“Owner”下，选择下拉菜单并点击一个 fork 仓库的拥有者。

    注意

    如果你的用户名显示为灰色，则表示 fork 已经存在。相反，你应该更新现有的 fork。有关更多信息，请参阅“同步 fork”。

  4. 默认情况下，fork 的名称与其上游仓库相同。可选地，为了进一步区分你的 fork，在“Repository name”字段中输入一个名称。

  5. 可选地，在“Description”字段中输入 fork 的描述。

  6. 可选地，选择 **Copy the DEFAULT branch only**。

    对于许多 fork 场景，例如为开源项目贡献代码，你只需要复制默认分支。如果你没有选择此选项，所有分支都将被复制到新的 fork 中。

  7. 点击 **Create fork**。

注意：如果你想从上游仓库复制其他分支，可以在 **Branches** 页面上进行操作。有关更多信息，请参阅“在仓库中创建和删除分支”。

克隆 fork

你已成功 fork 了 Spoon-Knife 仓库，但到目前为止，它只存在于 GitHub 上。为了能够在项目上工作，你需要将它克隆到你的计算机上。

你可以使用命令行、GitHub CLI 或 GitHub Desktop 克隆你的 fork。

  1. 在 GitHub 上，导航到 **你的 fork** 的 Spoon-Knife 仓库。

  2. 在文件列表上方，点击 Code.

    Screenshot of the list of files on the landing page of a repository. The "Code" button is highlighted with a dark orange outline.

  3. 复制仓库的 URL。

    • 要使用 HTTPS 克隆仓库，在“HTTPS”下，点击 .

    • 要使用 SSH 密钥克隆仓库，包括由您的组织的 SSH 证书颁发机构颁发的证书，请点击SSH，然后点击 .

    • 要使用 GitHub CLI 克隆仓库，请点击GitHub CLI，然后点击 .

      Screenshot of the "Code" dropdown menu. To the right of the HTTPS URL for the repository, a copy icon is outlined in dark orange.

  4. 打开终端终端Git Bash.

  5. 将当前工作目录更改为要克隆目录的位置。

  6. 输入git clone，然后粘贴您之前复制的 URL。它将如下所示，使用您的 GitHub 用户名代替YOUR-USERNAME

    git clone https://github.com/YOUR-USERNAME/Spoon-Knife

  7. 按Enter。您的本地克隆将被创建。

    $ git clone https://github.com/YOUR-USERNAME/Spoon-Knife
> Cloning into `Spoon-Knife`...
> remote: Counting objects: 10, done.
> remote: Compressing objects: 100% (8/8), done.
> remove: Total 10 (delta 1), reused 10 (delta 1)
> Unpacking objects: 100% (10/10), done.

要了解更多关于 GitHub CLI 的信息，请参阅“关于 GitHub CLI”。

要创建您的 fork 的克隆，请使用--clone标志。

gh repo fork REPOSITORY --clone=true

  1. 在文件菜单中，点击克隆仓库。

    Screenshot of the menu bar on a Mac. The "File" dropdown menu is expanded, and the "Clone Repository" option is highlighted with an orange outline.

    Screenshot of the "GitHub Desktop" menu bar on Windows. The "File" dropdown menu is expanded, and the "Clone Repository" option is highlighted with an orange outline.

  2. 点击与您要克隆的仓库位置相对应的选项卡。您也可以点击URL手动输入仓库位置。

    Screenshot of the "Clone a repository" window. At the top of the window, tabs labeled "GitHub.com", "GitHub Enterprise" and "URL" are highlighted with an orange outline.

  3. 从仓库列表中，点击您要克隆的仓库。

    Screenshot of the "Clone a repository" window. The "github/docs" repository is highlighted with an orange outline.

  4. 要选择要克隆仓库的本地目录，在“本地路径”字段旁边，点击选择...并导航到该目录。

    Screenshot of the "Clone a repository" window. A button, labeled "Choose", is highlighted with an orange outline.

  5. 在“克隆仓库”窗口底部，点击克隆。

创建分支以进行工作

在对项目进行更改之前，您应该创建一个新的分支并签出它。通过将更改保存在它们自己的分支中，您遵循 GitHub Flow 并确保将来更容易再次为同一个项目做出贡献。有关更多信息，请参阅“GitHub flow”。

git branch BRANCH-NAME
git checkout BRANCH-NAME

git branch BRANCH-NAME
git checkout BRANCH-NAME

有关如何在 GitHub Desktop 中创建和管理分支的更多信息，请参阅“在 GitHub Desktop 中管理分支”。

进行和推送更改

继续使用您喜欢的文本编辑器（如Visual Studio Code）对项目进行一些更改。例如，您可以更改index.html中的文本以添加您的 GitHub 用户名。

准备好提交更改时，请暂存和提交更改。git add .告诉 Git 您希望将所有更改包含在下一个提交中。git commit对这些更改进行快照。

git add .
git commit -m "a short description of the change"

git add .
git commit -m "a short description of the change"

有关如何在 GitHub Desktop 中暂存和提交更改的更多信息，请参阅“在 GitHub Desktop 中提交和审查对项目的更改”。

当您暂存和提交文件时，您实际上是在告诉 Git：“好的，对我的更改进行快照！”您可以继续进行更多更改，并进行更多提交快照。

目前，您的更改仅存在于本地。当您准备好将更改推送到 GitHub 时，请将更改推送到远程仓库。

git push

git push

有关如何在 GitHub Desktop 中推送更改的更多信息，请参阅“从 GitHub Desktop 推送更改到 GitHub”。

创建拉取请求

最后，您已准备好将更改提议到主项目中！这是生成他人项目分支的最后一步，也是最重要的步骤。如果您做出了您认为对整个社区有益的更改，您应该认真考虑回馈。

为此，请转到 GitHub 上您的项目所在的仓库。在本例中，它将位于 https://github.com/<your_username>/Spoon-Knife。您将看到一个横幅，表明您的分支比 octocat:main 超前一个提交。单击 **贡献**，然后单击 **打开拉取请求**。

GitHub 将带您到一个页面，该页面显示您的分支与 octocat/Spoon-Knife 仓库之间的差异。单击 **创建拉取请求**。

GitHub 将带您到一个页面，您可以在其中输入更改的标题和描述。重要的是要提供尽可能多的有用信息以及您首先创建此拉取请求的原因。项目所有者需要能够确定您的更改是否像您认为的那样对每个人都有用。最后，单击 **创建拉取请求**。

管理反馈

拉取请求是讨论的区域。如果项目所有者拒绝您的拉取请求或要求提供更多有关创建拉取请求的原因的信息，请不要感到冒犯。即使项目所有者选择不合并您的拉取请求，您的更改仍然存在于您的分支中。可能是其他人会发现您的分支比原始项目更有价值。

查找项目

您已成功分叉并回馈到仓库。继续前进，并贡献更多！有关更多信息，请参阅“在 GitHub 上寻找为开源做出贡献的方法”。