为项目贡献代码

学习如何通过 fork 贡献项目。

平台导航

本文内容

关于 fork

如果您想为其他人的项目贡献代码，但没有该仓库的写入权限，可以使用“fork 和拉取请求”工作流程。

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

您可以通过从您的 fork 向上游仓库提交拉取请求来贡献代码。有关更多信息，请参阅“Fork 仓库”。

Fork 仓库

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

  1. 导航到 https://github.com/octocat/Spoon-Knife 上的 Spoon-Knife 项目。

  2. 在页面右上角，点击Fork。

    Screenshot of the main page of repository. A button, labeled with a fork icon and "Fork 59.3k," is outlined in dark orange.

  3. 在“所有者”下，选择下拉菜单并点击 fork 仓库的所有者。

    注意

    如果您的用户名显示为灰色，则表示该分支已存在。您应该将现有分支更新到最新版本。有关更多信息，请参阅“同步分支”。

  4. 默认情况下，分支的名称与其上游存储库相同。您可以选择在“存储库名称”字段中输入一个名称来进一步区分您的分支。

  5. 您也可以选择在“描述”字段中输入您的分支的描述。

  6. 您也可以选择 **仅复制 DEFAULT 分支**。

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

  7. 点击 **创建分支**。

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

克隆分支

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

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

  1. 在 GitHub 上，导航到您为 Spoon-Knife 存储库创建的 **分支**。

  2. 在文件列表上方，点击 代码.

    Screenshot of the list of files on the landing page of a repository. The "Code" button is highlighted with a dark orange outline.

  3. 复制存储库的 URL。

    • 要使用 HTTPS 克隆存储库，在“HTTPS”下，点击 .

    • 要使用 SSH 密钥克隆存储库，包括由您的组织的 SSH 证书颁发机构颁发的证书，点击 **SSH**，然后点击 .

    • 要使用 GitHub CLI 克隆存储库，点击 **GitHub CLI**，然后点击 .

      Screenshot of the "Code" dropdown menu. To the right of the HTTPS URL for the repository, a copy icon is outlined in dark orange.

  4. 打开 终端终端Git Bash.

  5. 将当前工作目录更改为要克隆目录的位置。

  6. 输入 git clone，然后粘贴您之前复制的 URL。它将如下所示，使用您的 GitHub 用户名代替 YOUR-USERNAME

    git clone https://github.com/YOUR-USERNAME/Spoon-Knife

  7. 按 **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

  1. 在 **文件** 菜单中，点击 **克隆存储库**。

    Screenshot of the menu bar on a Mac. The "File" dropdown menu is expanded, and the "Clone Repository" option is highlighted with an orange outline.

    Screenshot of the "GitHub Desktop" menu bar on Windows. The "File" dropdown menu is expanded, and the "Clone Repository" option is highlighted with an orange outline.

  2. 点击与要克隆的存储库位置相对应的选项卡。您也可以点击 **URL** 手动输入存储库位置。

    Screenshot of the "Clone a repository" window. At the top of the window, tabs labeled "GitHub.com", "GitHub Enterprise" and "URL" are highlighted with an orange outline.

  3. 从仓库列表中，点击您想要克隆的仓库。

    Screenshot of the "Clone a repository" window. The "github/docs" repository is highlighted with an orange outline.

  4. 要选择您想要克隆仓库的本地目录，在“本地路径”字段旁边，点击**选择...**并导航到该目录。

    Screenshot of the "Clone a repository" window. A button, labeled "Choose", is highlighted with an orange outline.

  5. 在“克隆仓库”窗口底部，点击**克隆**。

创建分支以进行工作

在对项目进行更改之前，您应该创建一个新的分支并检出它。通过将更改保留在它们自己的分支中，您遵循 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 的最后一步，也是 arguably 最重要的一步。如果您做出了您认为对整个社区有益的更改，您绝对应该考虑回馈。

为此，请前往 GitHub 上您的项目所在的仓库。在本例中，它将位于https://github.com/<your_username>/Spoon-Knife。您将看到一个横幅，表明您的分支比octocat:main领先一个提交。点击**贡献**，然后点击**打开拉取请求**。

GitHub 将带您到一个页面，该页面显示您的 fork 和octocat/Spoon-Knife仓库之间的差异。点击**创建拉取请求**。

GitHub 会带你到一个页面，在那里你可以输入更改的标题和描述。重要的是要提供尽可能多的有用信息，以及你为什么要进行这个 pull request 的理由。项目所有者需要能够确定你的更改是否对你认为的那样对每个人都有用。最后，点击 **创建 pull request**。

管理反馈

Pull request 是一个讨论的区域。如果项目所有者拒绝你的 pull request，或者要求你提供更多关于为什么进行这个 pull request 的信息，不要感到被冒犯。即使项目所有者选择不合并你的 pull request，你的更改仍然存在于你的 fork 中。可能是其他人会发现你的 fork 比原始项目更有价值。

查找项目

你已经成功地 fork 了一个仓库并贡献了代码。继续前进，贡献更多！有关更多信息，请参阅 "在 GitHub 上寻找贡献开源项目的方法."