为项目做出贡献

关于分支

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

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

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

分支存储库

本教程使用 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 流程并确保将来更容易再次为同一项目做出贡献。有关详细信息，请参阅“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 上查找为开源做出贡献的方法”。

平台导航

工具导航

本文内容