Fork 代码库

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

平台导航

本文内容

关于分支

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

建议对其他人的项目进行更改

例如，你可以使用分支来建议与修复错误相关的更改。与其为发现的错误记录问题，不如：

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

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

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

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

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

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

先决条件

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

Fork 代码库

你可能需要为上游仓库（upstream repository）提出更改而创建项目的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. 在“所有者 (Owner)”下，选择下拉菜单并点击一个分叉仓库的所有者。

  4. 默认情况下，fork的名称与上游仓库相同。或者，为了更好地区分你的fork，在“仓库名称 (Repository name)”字段中输入一个名称。

  5. 或者，在“描述 (Description)”字段中输入你的fork的描述。

  6. 或者，选择**仅复制默认分支 (Copy the DEFAULT branch only)**。

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

  7. 点击**创建fork (Create fork)**。

注意

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

要了解更多关于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. 在**文件 (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. 阅读“你打算如何使用这个fork？”窗口中的信息。

    • 如果你计划将此fork用于为原始上游仓库贡献代码，请点击**为贡献给父项目 (To contribute to the parent project)**。
    • 如果你计划将此fork用于与上游无关的项目，请点击**为我自己的用途 (For my own purposes)**。

  7. 点击**继续 (Continue)**。

克隆你的fork仓库

现在，你已经拥有了Spoon-Knife仓库的fork，但是你的电脑本地没有该仓库的文件。

  1. 在GitHub上，导航到Spoon-Knife仓库的**你的fork**。

  2. 在文件列表上方，点击 代码 (Code).

    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. 打开终端 (Terminal)终端 (Terminal)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. 在**文件 (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以将你的fork与上游仓库同步

当你fork一个项目以向上游仓库提出更改时，你可以配置Git将更改从上游仓库拉取到你的fork的本地克隆中。

  1. 在GitHub上，导航到octocat/Spoon-Knife仓库。

  2. 在文件列表上方，点击 代码 (Code).

    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. 打开终端 (Terminal)终端 (Terminal)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进行任何更改，包括

  • **创建分支：**分支允许你在不危及主项目的情况下构建新功能或测试想法。
  • **打开拉取请求：**如果你想贡献回上游仓库，你可以通过提交拉取请求向原始作者发送请求，将你的fork拉取到他们的仓库。

查找另一个要fork的仓库

fork一个仓库以开始为项目贡献代码。你可以将任何公共仓库fork到你的个人帐户，或fork到你有权创建仓库的组织。如果你有权访问私有仓库并且所有者允许fork，你可以将仓库fork到你的个人帐户，或fork到你在GitHub Team中有权创建仓库的组织。你不能使用GitHub Free将私有仓库fork到组织。有关GitHub Team和GitHub Free的更多信息，请参阅“GitHub的方案”。有关何时可以fork仓库的更多信息，请参阅“关于fork的权限和可见性”。

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

后续步骤

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

  • 有关克隆fork以及从你的电脑同步fork仓库中更改的更多信息，请参阅“设置Git”。

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

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

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