作为初学者如何为开源项目做出贡献

2025-06-07

作为初学者如何为开源项目做出贡献

本文将介绍如何开始使用开源项目,更具体地说,如何作为新手为开源项目做贡献。为开源项目做贡献是提升编程技能和为社区做出贡献的绝佳途径。重要的是要理解,为开源项目做贡献不仅仅局限于编写代码,您还可以通过其他方式做出贡献,例如改进文档、组织项目、设计内容、审查代码等等。在继续阅读之前,我建议大家先阅读贡献指南和行为准则,它们描述了贡献所需的工作流程。

第一步是找到一个你可以贡献的项目,因为我们知道,对于初学者来说,找到一个可以贡献的项目是一项艰巨的任务。我建议你从小处着手,先选择一个小项目。你可能会问,为什么我要这样做呢?因为小项目进展更快,也更有可能让你的第一批贡献更进一步。有很多网站可以找到可以贡献的项目,但在本文中,我想推荐其中四个适合初学者的网站。这些网站是:

  1. good first issues.com

  2. 好的第一个问题.dev

  3. up-for-grabs.net

  4. github.com/explore

第四个网站比其他三个更通用,而且它并非只针对初学者,所以你需要在这方面多做一些功课。接下来,这四个网站应该足以帮助你找到一个项目,如果没有,那就选择一个你每天使用的工具,如果它是开源的,就为它做贡献。或者,你也可以关注这篇文章,我会向你展示一个代码库,你可以在其中进行非常简单的贡献。

本文假设您具有 git 的基本知识,我们将使用的 git 工作流程如下:

  1. 将存储库 fork 到你的 GitHub 帐户

  2. 在你的机器上克隆项目

  3. 在进行更改之前创建分支

  4. 进行更改

  5. 提交并推送您的更改

  6. 打开拉取请求

上述工作流程是最基本的,足以为开源项目做出贡献

  • 第一步是分叉你选择的项目所以你所要做的就是转到这个你可以在描述中找到的 URL,然后单击分叉按钮,然后你必须等待分叉完成,现在你可能会问为什么先分叉它而不是直接克隆它,当你分叉一个项目时,你会在你的帐户中复制它,因此,你可以在不影响原始存储库的情况下对其进行操作。分叉会创建一个单独的副本,而克隆会将项目下载到你的机器上,如果你只克隆它,你就无法对存储库进行更改,原因是只有授权人员才能通过分叉项目对存储库进行更改,你可以进行更改并提交请求,正如你所看到的,在分叉完成后,它会将你重定向到你的项目副本,它由你的 GitHub 用户名/存储库名称组成

  • 下一步是将 fork 的仓库克隆到你的机器上。前往你的 GitHub 帐户,打开 fork 的仓库,点击代码按钮,然后点击复制到剪贴板图标

克隆.png

打开终端并运行以下 git 命令:

git clone "URL you just copied"

Enter fullscreen mode Exit fullscreen mode

其中,“您刚刚复制的 URL”(不带引号)是此仓库(此项目的 fork)的 URL。请参阅前面的步骤获取该 URL。

复制到剪贴板.png

例如:

git clone https://github.com/this-is-you/Open-Source-Contribution.git

Enter fullscreen mode Exit fullscreen mode

其中 wherethis-is-you是你的 GitHub 用户名。在这里,你将 GitHub 上 first-contributions 仓库的内容复制到你的电脑上。

  • 下一步创建一个新的分支,以便人们可以在不相互冲突的情况下处理项目。此外,每个分支都独立于其他分支,因此除非合并,否则你分支的更改在其他分支中不可见。简而言之,你的分支保存着你对项目所做的更改。此外,请阅读每个项目的分支命名约定,它们会告诉你应该如何命名分支。例如,可以用你的名字/问题修复名称来命名。例如:muthu/add-name-1,这是我的名字/问题修复名称。你可以按如下方式创建一个新分支:

更改到计算机上的存储库目录(如果您尚未到达该目录):

cd Open-Source-Contribution

Enter fullscreen mode Exit fullscreen mode

现在使用以下命令创建一个分支git checkout

git checkout -b your-new-branch-name

Enter fullscreen mode Exit fullscreen mode

例如:

git checkout -b add-muthu-annamalai

Enter fullscreen mode Exit fullscreen mode

分支的名称中不需要包含“添加”一词,但包含它是合理的,因为该分支的目的是将您的名字添加到列表中。

  • 下一步是进行必要的更改并提交这些更改。您对每个项目所做的更改取决于项目内容以及您正在处理的问题。不过,使用这个示例 GitHub 仓库,我们将在文件中添加我们的名字,并将Contributors.md更改提交到我们的分支。提交信息必须尽可能简洁明了,但这并不意味着你应该写一本小说,所以我们可以写一些简短的内容,例如“添加我的名字”作为提交信息。

现在Contributors.md在文本编辑器中打开该文件,添加您的姓名并保存该文件。

如果您转到项目目录并执行命令git status,您将看到有变化。

使用以下命令将这些更改添加到刚刚创建的分支git add

git add Contributors.md

Enter fullscreen mode Exit fullscreen mode

现在使用以下命令提交这些更改git commit

git commit -m "Add <your-name> to Contributors list"

Enter fullscreen mode Exit fullscreen mode

<your-name>用你的名字替换。

  • 下一步是更改推送到 GitHub

使用以下命令推送您的更改git push

git push origin <add-your-branch-name>

Enter fullscreen mode Exit fullscreen mode

替换为您之前创建的分支的名称。

  • 下一步是提交您的更改以供审核

如果你访问 GitHub 上的仓库,你会看到一个“比较并拉取请求”按钮。点击该按钮。

比较拉取请求.jpeg

现在提交拉取请求。

提交拉取请求.jpeg

项目管理员很快就会将您的所有更改合并到他们项目的 master 分支中。合并完成后,您将收到一封通知邮件。

如果你一直关注这篇文章,无论项目复杂程度如何,你都应该能够做出开源贡献。我很想知道这篇文章是否对你有帮助,请在评论区留言。

如果您首次想为开源做出贡献,可以在我的代码库中进行。我很乐意帮助您完成您的首次开源贡献。

GitHub 仓库链接:https://github.com/muthuannamalai12/Open-Source-Contribution

现在您可以通过给我买一杯咖啡来表示您的支持。😊👇

给我买杯咖啡

如果您想联系我,可以通过以下方式联系:

感谢阅读😊

文章来源:https://dev.to/muthuannamalai12/how-to-contribute-to-open-source-projects-as-a-beginner-6cb
PREV
大O:空间复杂度
NEXT
HTML 基础知识以及您需要了解的一切