参与项目贡献

关于 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。
在“Owner”下，选择下拉菜单并点击一个 forked 仓库的所有者。

注意

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

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

注意

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

克隆 fork

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

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

在 GitHub 上，导航到您的 fork 的 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”。

要创建 fork 的克隆，请使用--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”。

创建 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 上为开源项目做贡献的方法”。

平台导航

工具导航

本文内容