不要在白嫖 Github 了！

DevWeekly 收集整理每周优质开发者内容，包括开源项目、工具资源、技术文章等方面,每周五首发于DevWeekly，欢迎大家 Star 并收藏！

提起 Github，很多同学第一印象就是一个巨大的宝藏库。

在这里面可以寻找到很多优秀、开源、免费的工具，而且如果在项目中遇到了难题，还可以找一个类似的克隆下来修修改改就发不上线。

但是，除了这些之外 Github 还是一个很不错的学习提升平台。

在之前的回答中我曾经提到过，如果想要提升代码水平，我们可以通过加入并贡献 Github 项目来实现。

通过加入 Github 项目，我们可以和其他开发者一起协同开发，在不断迭代和升级的过程中学习到很多贴近实际项目的技能。

下面，我就来详细介绍一下如何加入 Github 项目！

什么是开放源码？

在学习如何加入 Github 开源项目之前，首先需要了解一下什么是开源项目。

简单地说，开源项目（或软件）是具有开发源代码的软件，任何人都可以检查、修改和优化。

除了参与源代码的优化迭代，你还可以为项目的文档、项目中使用的图片、插图和视频等内容作出贡献。

因此，你可以选择一个开源项目，查看它包含哪些内容，找到一个 bug 并创建一个新的问题，或者处理一个现有的问题。

为什么贡献开源项目？

提起贡献和付出，很多同学一开始都会有一些排斥，因为，对于大多数用户来说索取远比贡献更容易接收。

但是，贡献开源项目则不同，因为在这个过程中，我们能够获取到很多东西：

• 高效学习：在参与开源项目的开发过程中，可以学到很多东西

• 曝光率：开源社区非常受欢迎，你将会和那些志同道合的人建立联系

• 实战经验：如果你是一个学生，或者是没有从事过任何实战项目的开发，那么这是一个很好的方式来获得实战项目开发经验的好机会，因为这些项目可能被成百上千甚至数百万人使用

现在，已经知道什么是开源项目以及为什么贡献开源项目。

那么，估计很多同学会有疑问：该怎么贡献开源项目呢？

别着急，下面就开发高速大家如何贡献开源项目！

贡献开源项目

第一步：选择项目

Github 上有数不胜数的项目，很多人打开 Github 估计都会一脸茫然，不知道该如何下手。

这时候，就需要有清晰地思路，根据你感兴趣的领域（数据分析、后端、前端、人工智能、微服务）、语言（Python、Java、Go、Java、C++）来缩小范围，筛选出你感兴趣的开源项目，这里已项目templates：

第二步：fork 仓库

进入项目仓库，你会在页面的右上方看到一个 fork 的选项：

然后，点击创建分支：

第三步：克隆分支代码

fork 后，你会被重定向到你的 GitHub 账户，这是会发现，在自己仓库里创建了一个原始项目的副本，我们可以在这个副本里做任何修改。

接下来，就在自己的电脑上克隆这个仓库：

• 复制这个仓库的 URL

• 在桌面上打开终端

• 使用 git clone [repository-url] 命令把项目克隆到本地

git clone

经过这些操作，项目就被克隆到本地了。

第四步：添加上游

我们需要将本地克隆的代码与原始版本库（最原始的，非 fork 到自己仓库的）连接起来，这个过程叫做添加上游（upstream）：

• 在克隆的文件夹中打开终端

• 使用 git remote add upstream [original repo URL]命令

要检查上游是否被成功添加，请使用下面这个命令：

git remote -v

如果它返回的信息如上图所示，那么就说明我们操作正确了。

注意，我们需要在你的克隆版本中添加上游，这样你就可以获取原始(mudit023/templates)版本中的修改。

可能还有其他的贡献者会在原始项目中进行修改，为了获取这些修改，你需要添加上游并执行下面命令：

git pull upstream main

这将确保你在本地克隆的版本库与原始远程仓库保持一致。

估计有的同学到这里有一些迷糊，不清楚 upstream 和 origin 什么区别，下面通过一个图示接阐述一下：

也就是说，我们先从原始仓库 fork 到自己的远程仓库，然后才从自己的远程 fork 克隆到本地，最后，再建立本地仓库和原始仓库的关系。

第五步：创建新分支

在进行任何修改和拉取代码（PR）之前，首先要创建一个新的分支（branch），然后，并从 main 分支切换到新分支。

创建新的分支并切换到该分支：

git branch -b newContributiongit checkout -b newContribution

你可以根据自己的喜好给分支起一个容易理解的名称。

第六步：贡献代码

到此为止已经做好了各种准备工作，接下来就是正式开始贡献代码了！

需要注意，着手之前先好好看一下 Readme，这是了解一个项目最直接的方式，通过 Readme 我们可以获取到很多有价值的信息，例如：

• 它会告诉你很多关于这个项目的信息

• 如何使用该项目

• 如何为该项目做贡献

• 当你遇到困难时，该如何寻求帮助

接下来，在标签栏可以看到 issues 选项，点击之后你可以看到这里罗列了很多其他人提出的问题，你可以在这里添加自己的问题。

当你点击一个问题时，你会看到问题的细节和互动内容，在那里你可以与维护者和其他贡献者讨论这个问题。

在开始处理一个问题之前，首先要对它进行评论，并告诉其他人你想处理这个问题。如果维护者将该问题分配给你，你就可以开始处理了。

第七步：添加并提交你的修改

在获得处理该问题的权限后，你可以在克隆的仓库中启动你的代码编辑器，并进行你想做的修改。

当你完成你的工作后，使用 git 命令来添加和提交你的修改：

git add .git commit -m "my first contribution"

第八步：创建 PR

目前，所做的修改只存在于你的系统中，我们必须从我们的系统中推送修改到 fork 的远程仓库（是 origin，不是 upstream）。

打开终端，输入下面命令即可：

git push origin newContribution

你已经把修改推送到了 fork 的副本仓库，但我们希望这些修改能被合并到原始项目中，这样才算得上是贡献。

为了合并你所做的修改，你必须创建一个 pull request（PR）。

当你创建 PR 时，你需要征得项目维护者/拥有者的同意来合并你所做的修改。

接下来看一下，如何创建一个 PR。

进入远程 fork 仓库，在它的主界面上，你会看到一个 create pull request。

点击它，你会看到一个像下面这样的界面：

再次点击 create pull request，会出现下面这样的界面：

在这里，你可以给你的 PR 起一个不同的消息或名字。当然，也可以使用默认的，然后再点击下面的 create pull request。

到这里就创建了一个 PR，你可以去原始仓库（upstream），你的 PR 将在 PR 部分可以看见。

点击你的 PR，检查它是否已经通过了所有的测试，并且没有任何合并冲突。

如果它没有合并冲突，并且你正确地遵循了项目的 PR 要求，维护者会很快合并你的 PR。

如果有任何问题，PR 部分也有一个评论区，你可以和维护者聊天，寻求帮助或审查。