Fork 存储库

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

平台导航

本文中

关于分支

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

向其他人的项目提出更改建议

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

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

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

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

有关将开源原则应用于你的组织在 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. 或者，选择仅复制默认分支。

    对于许多分叉场景（例如为开源项目做出贡献），您只需复制默认分支即可。如果您未选择此选项，所有分支都将被复制到新分叉中。

  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 上分叉的信息，请参阅本文的 Web 浏览器版本。

在 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 社区 中的讨论。