Skip to main content

如何贡献

报告错误

如果您发现了一个错误,我们强烈鼓励您将其报告给项目维护者。您可以通过在项目的问题跟踪器上创建一个新问题,或通过提交一个修复错误的 pull request 来做到这一点。在报告错误时,提供尽可能多的信息总是有帮助的,如果您能提供一个演示错误的示例,将会有很大帮助。

我想贡献代码 - 我该怎么做?

分叉(Fork)仓库,进行更改并提交一个 pull request。在提交 pull request 之前:

  • 确保您的更改经过充分测试,并且您已更新项目的文档。
  • 确保您的测试 (yarn run test) 和构建 (yarn run build) 在您的机器上本地正常运行,并确保所有测试都通过。

有关提交更改的任何指导?

虽然我们感谢代码贡献,但对贡献的代码更改进行分类和整合可能非常耗时。在处理您的 pull request 时,请考虑以下提示:

  • 功能适用于该仓库。如果不确定,请考虑在论坛上发帖。
  • 代码质量可接受。我们没有定义编码标准,但请确保代码通过 ESLint,并且看起来与仓库中的其他代码一致。
  • 设计质量可接受。这有点主观,因此您应该考虑在论坛上发布以获得具体指导。
  • pull request 的范围不宜过大。请考虑为每个功能提交单独的 pull request,因为大型 pull request 很耗时,难以理解。
  • 我们将尽快对您的 pull request 提供反馈。遵循上述提示将有助于确保您的更改被审核。