Skip to main content

如何贡献

报告错误​

如果您发现了一个错误，我们强烈建议您将其报告给项目维护者。您可以通过在项目的 Issue 跟踪器上创建一个新的 Issue，或者通过发送一个修复该错误的 Pull Request 来完成此操作。 在报告错误时提供尽可能多的信息总是有帮助的，如果您能提供一个演示该错误的示例，将会有很大帮助。

我想贡献代码 - 我该怎么做？​

Fork 仓库，进行更改并提交 Pull Request。在提交 Pull Request 之前：

  • 确保您的更改已经过充分测试，并且您已经更新了项目的文档。
  • 确保您的测试 (yarn run test) 和构建 (yarn run build) 在您的机器本地正确工作，并确保它们都通过。

关于提交更改的任何指导？​

我们确实非常感谢代码贡献，但分类和集成贡献的代码更改可能非常耗时。在处理您的 Pull Request 时，请考虑以下提示：

  • 功能是否适合该仓库。如果您不确定，请考虑在论坛上发布。
  • 代码质量是否可接受。我们没有定义编码标准，但请确保它通过 ESLint 并且看起来与仓库中的其他代码相似。
  • 设计质量是否可接受。这有点主观，所以您应该考虑在论坛上发布以获得具体指导。
  • Pull Request 的范围不应过大。请考虑为每个功能提交单独的 Pull Request，因为大的 Pull Request 非常费时且难以理解。
  • 我们会尽快对您的 Pull Request 提供反馈。遵循上述提示将有助于确保您的更改得到审查。