Fork 代码仓库

Fork 是一个新的仓库，它与原始的“上游”仓库共享代码和可见性设置。

平台导航

本文内容

关于 fork

Fork 是一个新的仓库，它与原始的“上游”仓库共享代码和可见性设置。Fork 常用于在将想法或更改建议回上游仓库之前进行迭代，例如在开源项目中，或者当用户无权访问上游仓库时。更多信息，请参阅“使用 fork”。

建议对其他人的项目进行更改

例如，您可以使用 fork 来建议与修复 bug 相关的更改。与其为发现的 bug 记录问题，您可以

  • Fork 代码仓库。
  • 进行修复。
  • 向项目所有者提交拉取请求。

将其他人的项目用作你自己的想法的起点

开源软件基于这样一个理念：通过共享代码，我们可以制作更好、更可靠的软件。更多信息，请参阅开源计划的“关于开源计划”。

有关将开源原则应用于您组织在 GitHub 上的开发工作的更多信息，请参阅 GitHub 的白皮书“内部源的介绍”。

从其他人的项目的 fork 创建公共仓库时，请务必包含一个许可文件，该文件确定您希望如何与他人共享您的项目。更多信息，请参阅 choosealicense.com 上的“选择开源许可证”。

有关开源的更多信息，特别是关于如何创建和发展开源项目，我们创建了开源指南，这些指南将通过推荐创建和维护开源项目仓库的最佳实践来帮助您培养健康的开源社区。您还可以参加一个关于维护开源社区的免费GitHub 技能课程。

先决条件

如果您尚未这样做，请首先从 Git 设置 Git 和与 GitHub.com 的身份验证。更多信息，请参阅“设置 Git”。

Fork 代码仓库

您可能会 fork 一个项目来建议对上游仓库进行更改。在这种情况下，定期将您的 fork 与上游仓库同步是一个好习惯。为此，您需要使用命令行上的 Git。您可以使用刚刚 fork 的同一个octocat/Spoon-Knife 仓库来练习设置上游仓库。

  1. 在 GitHub 上，导航到octocat/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. 在“所有者”下，选择下拉菜单并单击 Fork 代码仓库的所有者。

  4. 默认情况下，fork 的名称与上游仓库相同。或者，为了更好地区分您的 fork，可以在“仓库名称”字段中键入名称。

  5. 或者，在“描述”字段中，键入您的 fork 的描述。

  6. 或者，选择 **仅复制 DEFAULT 分支**。

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

  7. 点击 **创建 fork**。

注意

如果您想从上游仓库复制其他分支，您可以从 **分支** 页面进行操作。更多信息，请参见“在您的仓库中创建和删除分支”。

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

要创建仓库的 fork，请使用 gh repo fork 子命令。

gh repo fork REPOSITORY

要在组织中创建 fork，请使用 --org 标志。

gh repo fork REPOSITORY --org "octo-org"

您可以在 GitHub.com 或 GitHub Desktop 中 fork 仓库。有关在 GitHub.com 上 fork 的信息，请参见本文的网页浏览器版本。

在 GitHub Desktop 中，如果您尝试克隆您没有写入权限的仓库，则会自动为您创建一个 fork。

  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. 在“克隆仓库”窗口底部，点击 **克隆**。

  6. 阅读“您计划如何使用此 fork？”窗口中的信息。

    • 如果您计划将此 fork 用于为原始上游仓库做贡献，请点击 **为父项目做贡献**。
    • 如果您计划将此 fork 用于与上游无关的项目，请点击 **为我自己的目的**。

  7. 点击 **继续**。

克隆您的 fork 仓库

现在，您有一个 Spoon-Knife 仓库的 fork，但您计算机上本地没有该仓库的文件。

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

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

    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.
> remote: 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. 在“克隆仓库”窗口底部，点击 **克隆**。

配置 Git 以将您的 fork 与上游仓库同步

当您 fork 一个项目以向上游仓库提出更改时，您可以配置 Git 将更改从上游仓库拉取到您 fork 的本地克隆中。

  1. 在 GitHub 上，导航到octocat/Spoon-Knife 仓库。

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

    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. 将目录更改为您克隆的 fork 的位置。

    • 要转到您的主目录，只需键入 cd，无需其他文本。
    • 要列出当前目录中的文件和文件夹，请键入 ls。
    • 要进入列出的目录之一，请键入 cd YOUR-LISTED-DIRECTORY。
    • 要向上移动一个目录，请键入 cd ..。

  6. 键入 git remote -v 并按 **Enter** 键。您将看到您的 fork 的当前配置的远程仓库。

    $ git remote -v
> origin  https://github.com/YOUR-USERNAME/YOUR-FORK.git (fetch)
> origin  https://github.com/YOUR-USERNAME/YOUR-FORK.git (push)

  7. 键入 git remote add upstream，然后粘贴您在步骤 3 中复制的 URL 并按 **Enter** 键。它看起来像这样

    git remote add upstream https://github.com/ORIGINAL-OWNER/Spoon-Knife.git

  8. 要验证您为 fork 指定的新上游仓库，请再次键入 git remote -v。您应该看到您的 fork 的 URL 为 origin，上游仓库的 URL 为 upstream。

    $ git remote -v
> origin    https://github.com/YOUR-USERNAME/YOUR-FORK.git (fetch)
> origin    https://github.com/YOUR-USERNAME/YOUR-FORK.git (push)
> upstream  https://github.com/ORIGINAL-OWNER/ORIGINAL-REPOSITORY.git (fetch)
> upstream  https://github.com/ORIGINAL-OWNER/ORIGINAL-REPOSITORY.git (push)

现在，您可以使用一些 Git 命令来保持您的 fork 与上游仓库同步。更多信息，请参见“同步 fork”。

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

要为 fork 的仓库配置远程仓库，请使用 --remote 标志。

gh repo fork REPOSITORY --remote=true

要指定远程仓库的名称，请使用 --remote-name 标志。

gh repo fork REPOSITORY --remote-name "main-remote-repo"

编辑 fork

您可以对 fork 进行任何更改，包括

  • **创建分支：** 分支 允许您构建新功能或测试想法，而不会危及您的主要项目。
  • **打开拉取请求：** 如果你想为上游仓库做贡献，你可以通过提交拉取请求向原始作者发送请求，将你的 fork 拉取到他们的仓库中。

查找另一个要 fork 的仓库

fork 一个仓库以开始为项目做贡献。您可以将任何公共仓库 fork 到您的个人帐户或您有权创建仓库的组织。如果您有权访问私有仓库并且所有者允许 fork，您可以将仓库 fork 到您的个人帐户或您有权创建仓库的 GitHub Team 组织中。您不能使用 GitHub Free 将私有仓库 fork 到组织。有关 GitHub Team 和 GitHub Free 的更多信息，请参见“GitHub 的计划”。有关何时可以 fork 仓库的更多信息，请参见“关于 fork 的权限和可见性”。

您可以浏览 探索 GitHub 以查找项目并开始为开源仓库做贡献。更多信息，请参见“在 GitHub 上查找为开源做贡献的方法”。

后续步骤

您现在已经 fork 了一个仓库，练习了克隆您的 fork，并配置了一个上游仓库。

  • 有关从您的计算机克隆 fork 并同步 fork 仓库中更改的更多信息，请参见“设置 Git”。

  • 您还可以创建一个新的仓库，您可以在其中放置所有项目并在 GitHub 上共享代码。为您的项目创建仓库允许您在 GitHub 上存储代码。这为您提供了一个您可以选择与其他开发人员共享的工作备份。更多信息，请参见“仓库快速入门”。

  • GitHub 上的每个仓库都由个人或组织拥有。您可以通过在 GitHub 上连接和关注他们来与个人、仓库和组织互动。更多信息，请参见“在 GitHub 上寻找灵感”。

  • GitHub 拥有一个很棒的支持社区，您可以在那里寻求帮助并与来自世界各地的人们交谈。加入 GitHub 社区 的对话。