Fork 仓库

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

平台导航

本文内容

关于派生仓库

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

向他人的项目提出更改

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

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

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

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

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

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

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

先决条件

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

派生仓库

您可能会派生一个项目来向上游仓库提出更改。在这种情况下，定期将您的派生仓库与上游仓库同步是一个好习惯。为此，您需要在命令行中使用 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**。
    • 如果你打算使用此分叉来进行与上游无关的项目，请点击 **For my own purposes**。

  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. 在 **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并按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 社区 的对话。