为项目做出贡献

关于分叉

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

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

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

分叉存储库

本教程使用 Spoon-Knife 项目，这是一个托管在 GitHub.com 上的测试存储库，它允许你测试分叉和拉取请求工作流。

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

注意

如果你的用户名显示为灰色，则是因为分叉已经存在。相反，你应该使现有分叉保持最新。有关更多信息，请参阅“同步分叉”。
默认情况下，分叉的名称与其上游存储库的名称相同。或者，为了进一步区分你的分叉，在“存储库名称”字段中，键入一个名称。
或者，在“描述”字段中，键入你的分叉的描述。
或者，选择仅复制 DEFAULT 分支。

对于许多分叉场景，例如为开源项目做出贡献，你只需要复制默认分支。如果你不选择此选项，所有分支都将被复制到新分叉中。
点击创建分支。

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

克隆分支

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

您可以使用命令行、GitHub CLI 或 GitHub Desktop 克隆您的分支。

在 GitHub 上，导航到 Spoon-Knife 仓库的您的分支。
在文件列表上方，点击代码.
复制仓库的 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”。

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

gh repo fork REPOSITORY --clone=true

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

创建分支进行处理

在对项目进行更改之前，应创建一个新分支并签出。通过将更改保留在自己的分支中，你可以遵循 GitHub 流程并确保将来更容易再次为同一项目做出贡献。有关更多信息，请参阅“GitHub 流程”。

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”。

发出请求合并

最后，你准备将更改建议到主项目中！这是为他人项目制作分支的最后一步，也是最重要的。如果你做出了你觉得对整个社区都有益的更改，你绝对应该考虑回馈。

为此，请前往 GitHub 上存放你的项目的存储库。对于此示例，它位于 https://github.com/<your_username>/Spoon-Knife。你将看到一个横幅，指示你的分支比 octocat:main 超前一个提交。单击贡献，然后单击打开请求合并。

GitHub 将带你到一个页面，该页面显示了你的分支和 octocat/Spoon-Knife 存储库之间的差异。单击创建请求合并。

GitHub 将带你到一个页面，你可以在该页面输入标题和更改说明。最重要的是提供尽可能多的有用信息，以及你首先提出此拉取请求的原因。项目所有者需要能够确定你的更改是否像你认为的那样对每个人都有用。最后，单击创建拉取请求。

管理反馈

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

查找项目

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

平台导航

工具导航

本文内容