新手程序员的开源贡献入门指南:从修改文档开始-夜雨聆风

新手程序员的开源贡献入门指南:从修改文档开始

哈喽，你好，我是程序员火锅！今天想和你聊聊开源贡献这件事。很多人觉得参与开源是大佬才能干的事，其实不是，我来告诉你一个门槛极低的入门方法。

为什么从官方文档入手？

如果你想参与开源，但是面对一个庞大的代码库完全不知道从哪下手，那不妨先从官方文档入手，专门找里面的语法错误来修改。这个方法好用的原因有两个。

第一，上手成本低。了解一个项目，第一步本来就是读文档，读文档比读代码轻松太多了，你在熟悉项目的过程中顺手就能发现问题，不需要额外花时间去搞懂代码逻辑。

第二，正反馈来得快。修文档语法错误这件事相对简单，你不需要精通整个技术栈，提了 PR 之后合入的速度也更快。能在短时间内看到自己的 PR 被合入，这种成就感会让你更有动力继续做下去，慢慢再去挑战更难的 issue。

有人可能会说：“那些知名项目文档早就被人改完了吧？”其实没有。用的人多不代表贡献的人多，参与贡献的人只占很小一部分。以 xxl-job 为例，我就在大约两个月前为它提了一个修改文档语法错误的 PR，现在已经合入了。所以不管项目多成熟，文档里总有可以改的地方。

我当时的提交记录

最直接的方法是在 GitHub 上搜索带有 good first issue 标签的任务，这类 issue 通常描述清晰、改动范围小，专门为新手准备的。在搜索框里输入 is: issue is: open label:"good first issue" 就能筛出来。

如果觉得这样找太麻烦，可以去 goodfirstissue.dev 或者 goodfirstissues.com，这两个平台专门聚合了各大项目的新手友好 issue，还支持按编程语言筛选，省事很多。

选项目的时候，优先选你自己平时在用的工具或者库，因为你对它熟，更容易发现问题，也更能理解上下文。另外记得看一下项目的活跃度，最近有没有 commit、issue 回复快不快、PR 合并频率怎么样，别把时间花在一个已经没人维护的项目上。

找到项目之后，贡献流程分四步：Fork → Clone → Edit → PR。

先 Fork 原仓库，在你自己的 GitHub 账户下建一个副本。然后 Clone 到本地，新建一个分支来做修改，不要直接在 main 分支上改。改完之后提交一个清晰的 Commit，说明你改了什么，最后推送到远程仓库，创建 Pull Request，等维护者审查合并就行了。

有个小技巧：在任意开源项目的 GitHub 链接后面加上 /contribute，可以直接跳转到这个项目的入门级 issue 页面，比如 github.com/facebook/react/contribute，很方便。

动手之前，先读一下项目根目录里的 CONTRIBUTING.md 文件，里面一般会写清楚代码风格要求、提交规范和 PR 模板，按照要求来，被合入的概率会高很多。

提交的 PR 尽量小而专注，一个 PR 只解决一个问题，不要把好几个不相关的修改堆在一起。小 PR 审查起来快，合入也快，出了问题也好回滚。

提了 PR 之后，可能要等一段时间才有回应，这很正常，大多数维护者都是利用业余时间在做这件事。等了一周没动静，可以礼貌地提醒一下，但别催。收到审查意见的时候，不管是正面还是负面的，都当作学习机会就好，有人愿意花时间帮你看代码，这本身就是参与开源的价值之一。

还有一点：开源贡献不只是写代码。写文档、翻译、测试、回答用户问题，这些都算。如果你现在代码能力还不够强，完全可以先从这些地方切入，慢慢建立对项目的理解和社区里的信任感。

找一个你感兴趣的开源项目，从读它的官方文档开始，发现一个可以改的地方，Fork 仓库，提交你的第一个 PR。每一个资深的开源贡献者都是从这一步开始的，你也可以。

延伸阅读