参与项目

关于Fork

如果您想贡献给他人的项目，但没有该代码库的写入权限，您可以使用“Fork 和 Pull Request”工作流程。

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

您可以通过从您的 Fork 向上游代码库提交 Pull Request 来贡献代码。更多信息，请参阅“Fork 代码库”。

Fork 代码库

本教程使用 Spoon-Knife 项目，这是一个托管在 GitHub 上的测试代码库，可用于测试 Fork 和 Pull Request 工作流程。

导航到 https://github.com/octocat/Spoon-Knife 上的 Spoon-Knife 项目。
在页面右上角，单击Fork。
在“所有者”下，选择下拉菜单并单击 Fork 代码库的所有者。

注意

如果您的用户名显示为灰色，则表示该 Fork 已存在。您应该更新现有的 Fork。更多信息，请参阅“同步 Fork”。
默认情况下，Fork 的名称与其上游代码库相同。或者，为了更好地区分您的 Fork，可以在“代码库名称”字段中键入一个名称。
或者，在“描述”字段中，键入您的 Fork 的描述。
或者，选择仅复制 DEFAULT 分支。

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

注意

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

克隆Fork

您已成功 Fork Spoon-Knife 代码库，但到目前为止，它仅存在于 GitHub 上。要能够处理该项目，您需要将其克隆到您的计算机上。

您可以使用命令行、GitHub 命令行工具或 GitHub 桌面客户端克隆您的 Fork。

在 GitHub 上，导航到您的 Spoon-Knife 代码库的 Fork。
在文件列表上方，单击代码.
复制代码库的 URL。
- 要使用 HTTPS 克隆代码库，请在“HTTPS”下单击.
- 要使用 SSH 密钥克隆代码库（包括组织的 SSH 证书颁发机构颁发的证书），请单击SSH，然后单击.
- 要使用 GitHub 命令行工具克隆代码库，请单击GitHub 命令行工具，然后单击.
打开终端终端Git Bash。
将当前工作目录更改为您想要克隆目录的位置。
键入git clone，然后粘贴您之前复制的 URL。它将如下所示，其中您的 GitHub 用户名将替换YOUR-USERNAME
```
git clone https://github.com/YOUR-USERNAME/Spoon-Knife
```

按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.
> remove: Total 10 (delta 1), reused 10 (delta 1)
> Unpacking objects: 100% (10/10), done.

要了解有关 GitHub 命令行工具的更多信息，请参阅“关于 GitHub 命令行工具”。

要创建您的 Fork 的克隆，请使用--clone标志。

gh repo fork REPOSITORY --clone=true

在文件菜单中，单击克隆代码库。
单击与您要克隆的代码库位置相对应的选项卡。您也可以单击URL手动输入代码库位置。
从代码库列表中，单击您要克隆的代码库。
要选择要将代码库克隆到的本地目录，请在“本地路径”字段旁边，单击选择...并导航到该目录。
在“克隆代码库”窗口底部，单击克隆。

创建分支以进行工作

在更改项目之前，您应该创建一个新分支并检出它。通过将更改保留在其自己的分支中，您可以遵循 GitHub Flow，并确保将来更容易再次为同一项目贡献代码。更多信息，请参阅“GitHub Flow”。

git branch BRANCH-NAME
git checkout BRANCH-NAME

git branch BRANCH-NAME
git checkout BRANCH-NAME

要了解有关如何在 GitHub 桌面客户端中创建和管理分支的更多信息，请参阅“在 GitHub 桌面客户端中管理分支”。

进行和推送更改

继续使用您喜欢的文本编辑器（如 Visual Studio Code）对项目进行一些更改。例如，您可以更改index.html中的文本以添加您的 GitHub 用户名。

准备好提交更改后，暂存并提交更改。git add .告诉 Git 您想将所有更改包含在下一个提交中。git commit会对这些更改进行快照。

git add .
git commit -m "a short description of the change"

git add .
git commit -m "a short description of the change"

要了解有关如何在 GitHub 桌面客户端中暂存和提交更改的更多信息，请参阅“在 GitHub 桌面客户端中提交和查看对项目的更改”。

当您暂存和提交文件时，您实际上是在告诉 Git，“好的，对我的更改进行快照！”您可以继续进行更多更改，并进行更多提交快照。

目前，您的更改仅存在于本地。当您准备好将更改推送到 GitHub 时，请将更改推送到远程。

git push

git push

要了解有关如何在 GitHub 桌面客户端中推送更改的更多信息，请参阅“从 GitHub 桌面客户端将更改推送到 GitHub”。

发起Pull Request

最后，您准备好将更改建议到主项目中了！这是生成他人项目的 Fork 的最后一步，可以说是最重要的一步。如果您做出了您认为对整个社区都有益的更改，那么您绝对应该考虑回馈。

为此，请前往 GitHub 上托管您项目的代码库。在此示例中，它位于https://github.com/<your_username>/Spoon-Knife。您会看到一个横幅，指示您的分支比octocat:main领先一个提交。单击贡献，然后单击打开 Pull Request。

GitHub 将带您进入一个页面，该页面显示您的 Fork 与octocat/Spoon-Knife代码库之间的差异。单击创建 Pull Request。

GitHub 将带您进入一个页面，您可以在其中输入更改的标题和描述。提供尽可能多的有用信息以及您首先提出此 Pull Request 的理由非常重要。项目所有者需要能够确定您的更改是否像您认为的那样对每个人都有用。最后，单击创建 Pull Request。

管理反馈

Pull Request 是一个讨论的区域。如果项目所有者拒绝您的 Pull Request 或要求提供更多关于其原因的信息，请不要感到冒犯。即使项目所有者选择不合并您的 Pull Request，您的更改仍然存在于您的 Fork 中。其他人可能会发现您的 Fork 比原始项目更有价值。

查找项目

您已成功 Fork 并贡献回代码库。继续前进，贡献更多！更多信息，请参阅“在 GitHub 上查找为开源项目贡献代码的方法”。

平台导航

工具导航

本文内容