给开源新手的建议

本文最初发表于我的个人博客

我目前维护着几个代码库，这些代码库旨在帮助初学者学习如何为开源项目做贡献，并为他们提供机会。这是一段很棒的旅程，你可以在我的另一篇文章《我是如何通过创建开源项目来学习如何为开源项目做贡献的》中了解。

在我担任维护者期间，我注意到初学者也会犯同样的错误，或者遇到同样的问题感到困惑。因此，我决定将所有内容整理成一篇文章，希望能帮助到所有期待为开源项目做出贡献的初学者。

阅读贡献指南

几乎在每个开源仓库中，你都会找到一个名为 的文件CONTRIBUTING.MD。该文件包含向此仓库贡献代码的所有规则、如何进行更改的指南以及如何贡献代码。阅读该文件非常重要，因为它可以节省你大量时间来确定你需要做什么，并确保你的拉取请求（或 PR）遵循项目的所有准则，从而节省维护人员审核代码并提供所需更改的时间。

创建新分支

为项目做贡献的第一步是创建分支，以便进行修改并提交。但很多新手容易忽略的一个步骤是创建一个新的分支。不要先创建分支，然后再对主分支进行修改。这对于维护人员以及整个项目都非常有帮助。

在处理问题之前先分配任务

在某些开源项目中，情况可能有所不同，但我认为大多数项目都适用。通常，在为项目做贡献时，你会前往代码库的“问题”部分，查看需要哪些帮助。当你发现一个你认为可以解决的问题时，首先确保它尚未被分配，然后评论请求分配。很多贡献者会忽略某个问题已被分配给其他人的事实，或者忘记评论某个问题，这会导致在查看解决同一问题的 PR 时出现混乱。为了避免这种情况，请先评论该问题，获得分配后再提交你的 PR。

提交 PR 之前，请先创建问题

这适用于当您发现错误或有改进想法，但其内容不在代码库的“问题”部分时。很多贡献者会直接修复它并发送 PR。有时，如果只是修复拼写错误之类的小问题，问题可能不大。但是，如果是重大修改，尤其是基于您认为更好的方案，请务必先发送包含建议或错误报告的“问题”。如果维护人员认为您的想法正确，他们会将问题分配给您。但是，如果他们发现由于某种原因，该问题不适用于该项目，他们就会关闭它，这将节省您和他们的时间。

你不需要为每个变更创建一个新的 PR

我看到很多人对此感到困惑。贡献者会提交一个 PR，我会请求修改，然后贡献者会关闭这个 PR，并提交一个包含修改请求的新 PR。你不需要这么做。

当您想要对 PR 进行更改时，只需进行更改，然后将其提交到您发送 PR 的仓库即可。假设您 fork 了仓库并创建了一个新的分支 patch-1，然后在该分支中进行更改，然后提交并推送更改。更改将自动显示在 PR 中。

不要提交不必要的文件

我收到过一些 PR，其中包含一些对项目不必要的文件的提交，例如你的 IDE 配置文件。在提交更改之前，请先查看哪些更改了，并只提交与你正在处理的问题相关的更改。

不要灰心

我最喜欢的贡献者其实经常犯错。原因是他们一直告诉我他们是新手，犯了很多错误，所以我不得不不断地要求他们修改。说实话，我一度以为他们会关闭 PR 然后就此放弃。然而，他们坚持不懈，随着时间的推移，不仅提供了所需的结果，还带来了其他问题。一开始犯错没关系，这只是你学习如何下次做得更好的方式。

结论

如果您从未为开源项目做出贡献，或者对此犹豫不决，那么现在就应该开始。这非常重要，回馈社区将对您大有裨益。您可以参考以上建议，从简单的项目开始。即使只是小小的贡献，也能带来帮助。