Fork 代码库

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

平台导航

本文内容

关于 fork

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

为其他人的项目提出更改

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

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

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

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

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

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

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

前提条件

如果您尚未设置，请首先设置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”。

要创建代码库的fork，请使用gh repo fork子命令。

gh repo fork REPOSITORY

要在组织中创建fork，请使用--org标志。

gh repo fork REPOSITORY --org "octo-org"

您可以在GitHub.com或GitHub Desktop上fork代码库。有关在GitHub.com上fork的信息，请参见本文的网页浏览器版本。

在GitHub Desktop中，如果您尝试克隆您没有写入权限的代码库，则会自动为您创建一个fork。

  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. 阅读“您打算如何使用此fork？”窗口中的信息。

    • 如果您计划将此fork用于贡献给原始上游代码库，请点击为贡献给父项目。
    • 如果您计划将此fork用于与上游无关的项目，请点击为我自己的目的。

  7. 点击继续。

克隆您的fork代码库

现在，您已经fork了Spoon-Knife代码库，但是您的计算机上本地没有该代码库中的文件。

  1. 在GitHub上，导航到您的fork的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”。

要创建fork的克隆，请使用--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以将您的fork与上游代码库同步

当您fork一个项目以建议对上游代码库进行更改时，您可以配置Git将更改从上游代码库拉取到fork的本地克隆中。

  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. 将目录更改为您克隆的fork的位置。

    • 要转到您的主目录，只需键入cd，无需其他文本。
    • 要列出当前目录中的文件和文件夹，请键入ls。
    • 要进入列出的目录之一，请键入cd YOUR-LISTED-DIRECTORY。
    • 要向上移一个目录，请键入cd ..。

  6. 键入git remote -v并按Enter键。您将看到fork的当前配置的远程代码库。

    $ 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. 要验证您为fork指定的新的上游代码库，请再次键入git remote -v。您应该看到fork的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命令来保持您的fork与上游代码库同步。更多信息，请参见“同步fork”。

要了解有关GitHub CLI的更多信息，请参见“关于GitHub CLI”。

要为fork的代码库配置远程代码库，请使用--remote标志。

gh repo fork REPOSITORY --remote=true

要指定远程代码库的名称，请使用--remote-name标志。

gh repo fork REPOSITORY --remote-name "main-remote-repo"

编辑fork

您可以对fork进行任何更改，包括

  • 创建分支：分支允许您构建新功能或测试想法，而不会危及您的主要项目。
  • 打开pull请求：如果您想贡献回上游代码库，您可以通过提交pull请求向原始作者发送请求，将您的fork拉取到他们的代码库中。

查找另一个要fork的代码库

fork一个代码库以开始为项目做贡献。您可以将任何公共代码库fork到您的个人帐户，或fork到您有权创建代码库的组织。如果您有权访问私有代码库并且所有者允许fork，您可以将代码库fork到您的个人帐户，或fork到您有权创建代码库的GitHub团队组织。您不能使用GitHub免费版将私有代码库fork到组织。有关GitHub团队和GitHub免费版的更多信息，请参见“GitHub的计划”。有关何时可以fork代码库的更多信息，请参见“关于fork的权限和可见性”。

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

后续步骤

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

  • 有关克隆fork以及从您的计算机同步fork代码库中更改的更多信息，请参见“设置Git”。

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

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

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