Fork 仓库

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

平台导航

本文内容

关于分支

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

向他人的项目提出更改

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

  • 创建仓库分支。
  • 进行修复。
  • 向项目所有者提交拉取请求。

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

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

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

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

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

先决条件

如果您还没有，请先从 Git 设置 Git 和 GitHub.com 的身份验证。有关更多信息，请参阅“设置 Git”。

派生仓库

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

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

  2. 在页面右上角，单击 **派生**。

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

  3. 在“所有者”下，选择下拉菜单并单击派生仓库的所有者。

  4. 默认情况下，派生与它们的上游仓库同名。可选地，为了进一步区分您的派生，在“仓库名称”字段中，键入一个名称。

  5. 可选地，在“描述”字段中，键入派生的描述。

  6. 可选地，选择 **仅复制 DEFAULT 分支**。

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

  7. 单击 **创建派生**。

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

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

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

gh repo fork REPOSITORY

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

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

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

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

  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. 阅读“您打算如何使用此派生？”窗口中的信息。

    • 如果您打算使用此派生来为原始上游仓库做出贡献，请单击 **为父项目做出贡献**。
    • 如果您计划将此分支用于与上游无关的项目，请点击仅供个人使用。

  7. 点击继续。

克隆您的分支仓库

现在，您已经创建了 Spoon-Knife 仓库的分支，但您还没有将该仓库中的文件本地存储在您的计算机上。

  1. 在 GitHub.com 上，导航到您分支的 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”。

要创建分支的克隆，请使用--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 以将您的分支与上游仓库同步

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

  1. 在 GitHub.com 上，导航到 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. 将目录更改为克隆的分支所在的位置。

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

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

    $ 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. 要验证为您的分支指定的新上游仓库，请再次键入git remote -v。您应该看到您的分支的 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 命令将您的分支与上游存储库同步。有关更多信息，请参见“同步分支”。

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

要为分叉的存储库配置远程存储库，请使用--remote标志。

gh repo fork REPOSITORY --remote=true

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

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

编辑分支

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

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

查找另一个要分叉的存储库

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

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

下一步

您现在已经分叉了一个存储库，练习了克隆您的分支，并配置了一个上游存储库。

  • 有关克隆分支以及从您的计算机同步分叉存储库中的更改的更多信息，请参见“设置 Git”。

  • 您也可以创建一个新的仓库，用于存放所有项目并通过 GitHub 分享代码。为您的项目创建仓库可以让您将代码存储在 GitHub 上。这将提供您工作的备份，您可以选择与其他开发人员共享。有关更多信息，请参阅“仓库快速入门”。

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

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