Fork 仓库

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

平台导航

本文档

关于分支

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

向他人的项目提出更改

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

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

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

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

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

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

有关开源的更多信息，特别是如何创建和发展开源项目，我们创建了 开源指南，这些指南将通过推荐创建和维护开源项目存储库的最佳实践来帮助您培养健康的开源社区。您还可以参加 GitHub Skills 上的免费 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 上寻找为开源项目贡献代码的方法。"。

下一步

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

  • 有关从您的计算机克隆 fork 和同步 fork 存储库中更改的更多信息，请参阅 "设置 Git。"。

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

  • GitHub 上的每个存储库都归个人或组织所有。您可以通过在 GitHub 上连接和关注他们来与个人、存储库和组织进行互动。有关更多信息，请参阅 "在 GitHub 上寻找灵感。"。

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