Fork 存储库

分支是与原始“上游”存储库共享代码和可见性设置的新存储库。

平台导航

本文内容

关于分支

分支是与原始“上游”存储库共享代码和可见性设置的新存储库。分支通常用于在将想法或更改提议回上游存储库之前进行迭代，例如在开源项目中或用户无权访问上游存储库时。有关更多信息，请参阅“使用分支”。

向他人的项目提出更改

例如，您可以使用分支来提出与修复错误相关的更改。与其为发现的错误记录问题，您可以

  • 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 中。

  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 社区的对话。