Skip to main content
我们经常发布文档更新,此页面的翻译可能仍在进行中。 有关最新信息,请访问英语文档

参与项目

了解如何通过复刻参与项目。

关于复刻

如果想要参与他人的项目,但不具有对存储库的写入权限,可以使用“创建分支和拉取请求”工作流。

分支是一个新存储库,与原“上游”存储库共享代码和可见性设置。 分支通常用于在向上游存储库提出想法或修改之前进行迭代,比如在开放源代码项目中,或当用户没有对上游存储库的写入权限时。

可以通过将分支中的拉取请求提交到上游存储库来进行参与。 有关详细信息,请参阅“为存储库创建分支”。

复刻仓库

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

  1. 导航到位于 https://github.com/octocat/Spoon-KnifeSpoon-Knife 项目。
  2. 单击“分支”。 分叉按钮
  3. 为分支存储库选择所有者。 创建一个突出显示所有者下拉菜单的新分支页
  4. 默认情况下,分支的名称与其上游存储库的名称相同。 可更改分支的名称以进一步区分它。 创建一个突出显示存储库名称字段的新分支页
  5. 可以选择性地添加分支的说明。 创建一个突出显示说明字段的新分支页
  6. 选择是仅将默认分支还是将所有分支复制到新分支。 对于许多分支场景(例如参与开源项目),你只需复制默认分支。 默认情况下,只复制默认分支。 只复制默认分支的选项
  7. 单击“创建分支”。 突出显示的“创建分支”按钮

注意:如果要从上游存储库复制其他分支,可从“分支”页执行此操作 。 有关详细信息,请参阅“创建和删除存储库中的分支”。

克隆复刻

您已经成功复刻了 Spoon-Knife 存储库,但到目前为止,它仅存在于 GitHub 上。 为了能够处理该项目,您需要将其克隆到您的计算机。

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

  1. 在 GitHub 上,导航到 Spoon-Knife 存储库的分支。

  2. 在文件列表上方,单击 “代码”。 “代码”按钮

  3. 复制存储库的 URL。

    • 要使用 HTTPS 克隆存储库,在“HTTPS”下单击
    • 要使用 SSH 密钥克隆存储库,包括组织的 SSH 证书颁发机构颁发的证书,请单击“SSH”,然后单击
    • 要使用 GitHub CLI 克隆存储库,请单击“GitHub CLI”,然后单击 用于复制 URL 以使用 GitHub CLI 克隆存储库的剪贴板图标 1. 打开终端终端Git Bash。 4. 将当前的工作目录更改为您想要存储克隆目录的位置。
  4. 键入 git clone,然后粘贴之前复制的 URL。 它将如下所示,使用你的 GitHub 用户名替换 YOUR-USERNAME

    $ git clone https://github.com/YOUR-USERNAME/Spoon-Knife
  5. 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. 在“文件”菜单中,单击“克隆存储库” 。

    Mac 应用程序中的克隆菜单选项

    Windows 应用程序中的克隆菜单选项

    1. 单击与要克隆的仓库位置对应的选项卡。 也可以单击 URL 手动输入存储库位置。

    克隆仓库菜单中的 Location(位置)选项卡

    克隆仓库菜单中的 Location(位置)选项卡

    1. 从列表中选择要克隆的仓库。

    克隆仓库列表

    克隆仓库列表

    1. 单击“选择...”并找到要克隆存储库的本地路径。

    选择按钮

    选择按钮

    1. 单击“克隆”。

    克隆按钮

    克隆按钮

创建分支以处理

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

git branch BRANCH-NAME
git checkout BRANCH-NAME
git branch BRANCH-NAME
git checkout BRANCH-NAME

有关如何在 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 中暂存和提交更改的详细信息,请参阅“提交和查看项目的更改”。

暂存和提交文件时,您主要是告诉 Git:“好吧,拍摄我的更改快照!” 您可以继续进行更多更改,并拍摄更多提交快照。

目前,您的更改仅存在于本地。 当您准备好将更改推送到 GitHub 时,请将更改推送到远程。

git push
git push

有关如何在 GitHub Desktop 中推送更改的详细信息,请参阅“将更改推送到 GitHub”。

创建拉取请求

最后,您可以对主项目提出更改建议了! 这是产生他人项目复刻的最后一步,可以说是最重要的一步。 如果您做了您认为有益于整个社区的改变,绝对应该考虑回馈社区。

为此,请转到项目所在的 GitHub 存储库。 在本示例中,它位于 https://github.com/<your_username>/Spoon-Knife。 你将看到一个横幅,指示你的分支是 octocat:main 之前的一个提交。 单击“参与”,然后单击“打开拉取请求” 。

GitHub 会将你带到一个页面,其中显示了分支和 octocat/Spoon-Knife 存储库之间的差异。 单击“创建拉取请求”****。

GitHub 将带您进入一个页面,您可以在其中输入更改的标题和说明。 重要的是要提供尽可能多的有用信息,在首要位置说明您提出此拉取请求的理由。 项目所有者需要能够确定您的更改是否像您认为的那样对每个人都有用。 最后,单击“创建拉取请求”。

管理反馈

拉取请求是一个讨论区域。 在这种情况下,Octocat 非常繁忙,可能不会合并您的更改。 对于其他项目,如果项目所有者拒绝您的拉取请求,或者要求提供有关请求原因的更多信息,请不要生气。 甚至可能是项目所有者选择不合并您的拉取请求,这完全没问题。 更改存在于分支中。 谁知道呢 - 也许您从未见过的人会发现您的更改比原始项目更有价值。

查找项目

您已成功复刻并回馈存储库。 来吧,再贡献一些!有关详细信息,请参阅“查找在 GitHub 上为开放源代码做出贡献的方法”。