Fork 代码库

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

平台导航

本文内容

关于 fork

Fork 是一个新的代码库，它与原始“上游”代码库共享代码和可见性设置。Fork 通常用于迭代想法或更改，然后再将其提交回上游代码库，例如在开源项目中，或者当用户无权访问上游代码库时。有关更多信息，请参阅“使用 fork”。

向其他人的项目提出更改

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

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

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

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

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

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

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

先决条件

如果您尚未完成，请先设置 Git 并使用 Git 从 GitHub.com 进行身份验证。有关更多信息，请参阅“设置 Git”。

Fork 代码库

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

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

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

  7. 单击**创建 fork**。

注意

如果您想从上游仓库复制其他分支，可以在**分支**页面进行操作。更多信息，请参阅“在仓库中创建和删除分支”。

要了解有关 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 上，导航到**您的分支**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 上，导航到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 Team 组织。您不能使用 GitHub Free 将私有仓库分支到组织。有关 GitHub Team 和 GitHub Free 的更多信息，请参阅“GitHub 的计划”。有关何时可以创建仓库分支的更多信息，请参阅“关于分支的权限和可见性”。

您可以浏览探索 GitHub以查找项目并开始为开源仓库贡献。更多信息，请参阅“查找为 GitHub 上的开源项目贡献的方法”。

后续步骤

您现在已经创建了一个仓库的分支，练习了克隆您的分支，并配置了一个上游仓库。

  • 有关从您的计算机克隆分支和同步分支仓库中更改的更多信息，请参阅“设置 Git”。

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

  • GitHub 上的每个仓库都由个人或组织拥有。您可以通过在 GitHub 上连接和关注他们来与个人、仓库和组织互动。更多信息，请参阅“在 GitHub 上寻找灵感”。

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