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. 可选地，选择仅复制 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 社区 的对话。