我的第一个GitHub项目:方法

关于如何为您的第一个GitHub项目做出贡献的步骤

因此,您已经决定要开源

经过同仁的压力和FOMO,您已经决定要尝试这个GitHub贡献的东西,并选择了一个值得您的才华的项目。 这篇文章描述了开始GitHub之旅所需采取的步骤,以及如何继续进行下去。

步骤1:叉

好的,您已经在GitHub上选择了一个开源项目,并希望对此做出贡献。

让我们来

kgellci / Area51
适用于iOS的开源Reddit客户端完全内置于Swift中– kgellci / Area51 github.com

(顺便说一句,如果您想磨练您的Swift语言和iOS SDK技能,则是一个完全rad开源的iOS项目)作为您想要的开源项目。

从哪里开始?

好的,首先,您需要分叉该项目。 这是什么,它将在您的 GitHub个人资料中以您的名字创建该主存储库(kgellci / Area51)的副本,如下所示:https://github.com/yourusername/Area51/。

您所需要做的就是,转到所需的项目存储库,然后单击“ Fork”按钮,如下图所示。

然后,GitHub会告诉您它正在以您的名字创建一个新的存储库,大约需要30秒才能完成该过程。

和瞧! 您拥有第一个分叉的存储库。

第2步:克隆

现在,您已经有了代码库,可以开始编码了。 接下来要做的就是在本地计算机上克隆存储库。

  1. 转到您的存储库(https://github.com/yourusername/Area51/),然后单击“克隆或下载”按钮,如下所示。

2. GitHub将打开一个带有HTTPS URL的小弹出窗口,格式为:https://github.com/yourusername/Area51.git。 复制该链接。

注意:如果选择复制SSH URL链接,则可能需要为本地计算机设置SSH密钥。 要了解如何执行此操作,请转到以下链接:https://help.github.com/en/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

3.然后,打开您的终端并将目录更改为所需的位置。

4.键入git clone https://github.com/yourusername/Area51.git并按Enter。 Git将在您指定的位置创建您的项目的本地克隆。

步骤3:提交

这是该过程中最简单的步骤。 您现在所需要做的就是编写代码。 您可以打开项目的本地克隆并进行所需的更改。 然后,提交更改并将更改推送到远程存储库(https://github.com/yourusername/Area51/)。

注意:提交更改时,请记住添加结构化提交消息。 您可以在这里找到一些有关构造提交消息的有用指南:https://chris.beams.io/posts/git-commit/

第四步:公关

好的,现在,您的更改已存在于存储库中。 接下来要做的是将您的更改发送到存储库(https://github.com/kgellci/Area51/),以便将其集成到主代码库中。

为此,您需要做的就是打开一个请求请求。 拉取请求(PR)是GitHub要求主存储库所有者检查您的代码更改,对其进行注释的方法,如果一切都完美,则将您的更改集成到主存储库中。

您可以转到项目页面上的Pull Requests选项卡(如下所示)并单击“ New Pull Request”按钮来打开PR。

GitHub现在将打开从您的存储库到主存储库的PR,并将您带到PR Review页面,如下图所示。

在此页面中,您可以看到您的代码库和主要代码库之间的区别。 而且,主存储库的所有者可以突出显示他们需要与您讨论的任何代码更改,并在合并两个代码库之前要求对您的代码进行更改。

如果您需要进行一些更改以适应主要存储库所有者的请求,则只需将其他更改提交到自己的存储库中,PR就会自动使用新更改进行更新。

注意:初始PR后,使用请求的更改更新代码后,主存储库所有者将不会收到任何其他通知。 为了使主要存储库所有者重新查看您的更改,您必须对PR进行评论或通过任何其他方式告知他们。

步骤5:合并

现在剩下要做的就是合并请求请求。 这是主要存储库所有者的责任。 因此,请坐下来,放松并等待您的更改被合并。

步骤6:同步

因此,在您所做的更改被合并后,您可以为自己分配一个新的问题并继续做出贡献。 但是,重要的一步仍然存在。 您的派生存储库不会自动随主存储库中的每个新添加而更新。 为了使分支的存储库保持最新,您必须将分支的存储库代码库与主存储库代码库同步。

为此,请按照以下说明进行操作。

  1. 首先,将主存储库作为远程存储库添加到本地计算机的存储库中。

git remote add upstream git@github.com:kgellci/Area51.git

2.接下来,将更改从主存储库获取到本地计算机。

git fetch upstream

3.现在,您需要将主存储库中的更改合并到本地分支。 为此,请签出本地分支机构。

git checkout master

4.将主要存储库更改合并到本地存储库分支。

git merge upstream/master

5.最后,将合并的代码库推送到您的远程存储库(https://github.com/yourusername/Area51/)。

git push origin master

现在,您可以继续处理新问题。

结论

通过执行上述步骤1至6,并继续重复步骤3至6,您现在可以成为所需GitHub项目的重要贡献者。

本指南是通过使用以下非常有用的资源整理而成的。

创建一个SSH密钥:

生成一个新的SSH密钥并将其添加到ssh-agent中— GitHub Help
在将新的SSH密钥添加到ssh-agent来管理您的密钥之前,您应该具有在将SSH密钥添加到…时的帮助。

对GitHub项目的贡献:

Git –为项目做贡献
从历史上看,“ fork”一词在上下文中一直是负面的,这意味着有人参加了一个开源项目… git-scm.com

同步fork:

同步fork – GitHub帮助
同步存储库的分支,以使其与上游存储库保持最新。 help.github.com

Interesting Posts