为项目做出贡献

关于 fork

如果您想为别人的项目做出贡献，但没有对仓库的写权限，您可以使用“fork 和拉取请求”工作流。

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

您可以通过从您的 fork 向上游仓库提交拉取请求来做出贡献。有关详细信息，请参阅“fork 仓库”。

分叉存储库

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

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

注意

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

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

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

克隆分叉

你已成功分叉 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 Flow，并确保将来更容易再次为同一项目做出贡献。有关更多信息，请参阅“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 上查找为开源做出贡献的方法”。

平台导航

工具导航

本文内容