为项目做贡献

关于 Fork

如果您想为其他人的项目做出贡献，但没有该存储库的写入权限，则可以使用“Fork 和拉取请求”工作流。

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

您可以通过从您的 Fork 提交拉取请求到上游存储库来做出贡献。有关更多信息，请参阅“Fork 存储库”。

Fork 存储库

本教程使用Spoon-Knife 项目，这是一个托管在 GitHub 上的测试存储库，可让您测试 Fork 和拉取请求工作流。

导航到 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 CLI 或 GitHub Desktop 克隆您的 Fork。

在 GitHub 上，导航到 Spoon-Knife 存储库的您的 Fork。
在文件列表上方，点击代码.
复制存储库的 URL。
- 要使用 HTTPS 克隆存储库，请在“HTTPS”下，点击.
- 要使用 SSH 密钥（包括您的组织的 SSH 证书颁发机构颁发的证书）克隆存储库，请点击SSH，然后点击.
- 要使用 GitHub CLI 克隆存储库，请点击GitHub CLI，然后点击.
打开终端终端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 CLI 的更多信息，请参阅“关于 GitHub CLI”。

要创建 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 Desktop 中创建和管理分支的更多信息，请参阅“在 GitHub Desktop 中管理分支”。

进行和推送更改

继续使用您喜欢的文本编辑器（如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 Desktop 中暂存和提交更改的更多信息，请参阅“在 GitHub Desktop 中提交和审查对项目的更改”。

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

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

git push

git push

有关如何在 GitHub Desktop 中推送更改的更多信息，请参阅“从 GitHub Desktop 推送更改到 GitHub”。

发起拉取请求

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

为此，请转到 GitHub 上您的项目所在的存储库。在此示例中，它将在 https://github.com/<your_username>/Spoon-Knife。您将看到一个横幅，指示您的分支比 octocat:main 超前一个提交。点击贡献，然后点击打开拉取请求。

GitHub 将带您进入一个页面，该页面显示您的 Fork 和 octocat/Spoon-Knife 存储库之间的差异。点击创建拉取请求。

GitHub 将带您进入一个页面，您可以在其中输入更改的标题和描述。提供尽可能多的有用信息以及您首先发起此拉取请求的原因非常重要。项目所有者需要能够确定您的更改是否像您想象的那样对每个人都有用。最后，点击创建拉取请求。

管理反馈

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

查找项目

您已成功 Fork 并回馈到存储库。继续前进，并做出更多贡献！有关更多信息，请参阅“在 GitHub 上查找为开源做出贡献的方法”。

平台导航

工具导航

本文内容