Fork 存储库

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

平台导航

本文内容

关于分叉

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

向他人的项目提出更改

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

  • 分叉存储库。
  • 进行修复。
  • 向项目所有者提交拉取请求。

使用他人的项目作为你自己的想法的起点。

开源软件基于这样的理念：通过共享代码，我们可以制作出更好、更可靠的软件。有关更多信息，请参阅开放源代码倡议组织的“关于开放源代码倡议”。

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

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

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

先决条件

如果你尚未进行设置，请首先从 Git 设置 Git 和与 GitHub.com 的身份验证。有关更多信息，请参阅“设置 Git”。

分叉存储库

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

  1. 在 GitHub.com 上，导航到 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. 或者，选择仅复制默认分支。

    对于许多 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. 阅读“你计划如何使用此分支？”窗口中的信息。

    • 如果你计划使用此分支为原始上游存储库做出贡献，请单击为父项目做出贡献。
    • 如果你计划将此分支用于未连接到上游的项目，请单击用于我自己的目的。

  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"

编辑分支

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

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

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

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