Fork 仓库

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

平台导航

本文档

关于 Fork

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

向他人的项目提出更改

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

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

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

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

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

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

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

先决条件

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

Fork 仓库

您可能需要为项目创建一个分支，以向主仓库提出更改建议。在这种情况下，定期将您的分支与主仓库同步是一个好习惯。为此，您需要在命令行中使用 Git。您可以使用您刚刚分叉的相同 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. 在“Owner”下，选择下拉菜单并点击分叉仓库的拥有者。

  4. 默认情况下，分支的名称与其主仓库相同。您可以选择在“Repository name”字段中输入一个名称，以进一步区分您的分支。

  5. 您也可以选择在“Description”字段中输入分支的描述。

  6. 您也可以选择Copy the DEFAULT branch only。

    对于许多分叉场景，例如为开源项目贡献代码，您只需要复制默认分支。如果您没有选择此选项，所有分支都将被复制到新的分支中。

  7. 点击Create fork。

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

要了解有关 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. 在File菜单中，点击Clone Repository。

    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. 要选择要克隆仓库的本地目录，请在“Local Path”字段旁边点击Choose...并导航到该目录。

    Screenshot of the "Clone a repository" window. A button, labeled "Choose", is highlighted with an orange outline.

  5. 在“Clone a Repository”窗口底部，点击Clone。

  6. 阅读“How are you planning to use this fork?”窗口中的信息。

    • 如果您计划使用此分支来为原始主仓库贡献代码，请点击To contribute to the parent project。
    • 如果您计划将此分支用于与上游无关的项目，请点击仅供个人使用。

  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. 按回车键。您的本地克隆将被创建。

    $ 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. 在File菜单中，点击Clone Repository。

    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. 要选择要克隆仓库的本地目录，请在“Local Path”字段旁边点击Choose...并导航到该目录。

    Screenshot of the "Clone a repository" window. A button, labeled "Choose", is highlighted with an orange outline.

  5. 在“Clone a Repository”窗口底部，点击Clone。

配置 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 并按回车键。您将看到分支的当前配置的远程仓库。

    $ 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 并按回车键。它将类似于以下内容

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