开源软件新贡献者常犯的 7 个错误

为开源软件做出贡献是改变社区并学习如何在团队中工作的绝佳途径。作为一名开源维护者，我喜欢与新贡献者合作，并见证社区以积极的方式发展。但随着我越来越多地参与开源项目，我注意到新贡献者常犯的一些错误。

在这篇博文中，我将介绍开源项目新贡献者常犯的 7 个错误。

目录

• 忽略贡献文档
• 拾取不可用的问题
• 在评审之前不审查自己的作品
• 为未要求的功能创建 PR
• 创建非描述性问题
• 创建非描述性的 PR 标题
• 忽略拉取请求和问题模板
• 结论

忽略贡献文档

贡献文档的目的是帮助有兴趣为新项目做出贡献的开发者加入。优秀的开源项目通常都有定义清晰的贡献文档，其中包含以下内容：

• 如何在本地设置项目
• 提交消息约定
• 拉取请求指南
• 可接受的捐款类型

所有开发者务必通读本文档，以便了解维护人员的需求。如果您忽略贡献文档，最终很可能会创建一个不需要或不需要的 PR。这通常会导致维护人员不得不关闭该 PR。

如果您找到一个有兴趣贡献的项目，请花时间阅读 README 和贡献文档。如有任何疑问，请联系维护人员，他们会很乐意为您提供帮助。

拾取不可用的问题

我在 Hacktoberfest 期间遇到的一个问题是，一些开发人员会接手已经分配给其他人的问题。然后，该贡献者会发起一个 PR 请求审核，结果我把它关闭了。

我理解，对于初学者来说，有时很难找到可以处理的 issue。但是，如果某个 issue 不可用，请不要指望维护人员会接受你的 PR，而不是其他被分配到该 issue 的 PR。

如果您正在努力寻找好的第一期，那么我建议您查看以下资源：

• 好第一期
• 非常适合初学者
• 仅限首次参加者

在评审之前不审查自己的作品

我在 Hacktoberfest 期间维护代码库时注意到的一件事是，很多新手提交的 PR 根本没仔细看。我发现很多拼写错误、语法错误，或者功能未经测试或无法正常工作。

在向维护者请求审核之前，请务必快速审核一下自己的工作，并在本地运行这些更改。在最初处理某个问题时，你可能会惊讶于其中可能出现的 bug 和错误数量。但再次审核 PR 可以帮助你发现这些错误，并改进 PR。

为未要求的功能创建 PR

作为一名维护者，我遇到过一些开发者为我们并不打算添加到项目中的功能创建 PR 的情况。这些开发者的初衷是好的，但不幸的是，他们浪费了自己的时间，最终却被关闭了。

如果您对某个功能有新想法，请不要立即着手处理并提交 PR。您应该为您的功能请求创建一个新的 Issue。届时，维护人员会与您联系，告知您是否希望继续推进您的功能。

创建非描述性问题

创建问题时，务必提供尽可能详细的信息，以便维护人员了解如何更好地回复您。例如，如果您在网站上发现了一个 Bug，请务必提供如何重现该 Bug 的详细信息，并在适用的情况下提供链接、屏幕截图或视频。这将使维护人员有机会排查问题并确定下一步的最佳行动方案。

创建非描述性的 PR 标题

作为维护者，我经常遇到的一个问题是 PR 的标题过于笼统和模糊。像“更新 Readme”或“修复 bug”这样的标题无法帮助维护者理解你的 PR 意图。重要的是，你需要一个简短的描述性标题，能够有效地传达你想要做的修改。

忽略拉取请求和问题模板

许多开源项目都会设置问题和 PR 模板，以确保贡献者提供所有必要的信息。问题模板通常会分为不同的类别，例如 Bug、功能、文档等。作为贡献者，选择合适的问题模板并填写所有必填字段非常重要，这样维护人员才能知道如何为您提供帮助。

以下是 PR 模板的示例：

# Description

<!-- Please include a detailed summary of the changes made. Also please link the issue that this PR is fixing. -->

Fixes # (issue)

<!-- Please place an x in the [ ] to check off the type of change for this PR -->

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Chore items (this includes basic clean up of files, or updates to packages)
- [ ] Updates to documentation

<!-- Please make sure to go through the entire checklist before requesting a review. Place an x in the [ ] to check off all of the items completed -->

## Checklist

- [ ] I have a descriptive title for my PR
- [ ] I have linked the issue to this [PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
- [ ] I have run the project locally and reviewed the code changes
- [ ] My changes generate no new warnings

作为贡献者，遵循清单上的所有项目非常重要，这有助于确保您的新更改不会意外破坏应用程序的其他部分。

结论

参与开源软件是开启团队合作、为现实世界项目做出有意义贡献的绝佳途径。虽然开源领域有很多值得学习的地方，但请注意新贡献者常犯的这 7 个错误。

如果您在开源中还有更多常见的错误，请在下面的评论部分回复。

编码愉快！