代码审查指南#

本文档概述了在您创建或审查拉取请求时应遵循的一般指南。

要有同理心#

我们建议您阅读关于同理心与拉取请求和代码审查如何进行，以了解更多关于在代码审查中保持同理心的信息。

如果您的拉取请求涉及任何代码，您必须为其编写或更新文档。对于这个项目，文档比代码重要得多。如果一个功能没有文档，它就不存在。如果一个行为没有文档，它就是一个 bug。

不要担心文档是否完美！文档会随着时间的推移而改进。要求是在合并拉取请求之前要有文档，而不是在合并拉取请求之前要有完美的文档。如果您是新手，不确定如何添加文档，其他贡献者将很乐意指导您。

请参阅编写文档，了解有关编写文档的指南。

如果您的拉取请求涉及任何代码，您必须编写单元测试或集成测试来测试它。这有助于验证和传达您的拉取请求按预期工作。它还确保您不会意外地破坏其他代码，并使将来的拉取请求更难破坏您拉取请求中添加的代码。

由于 TLJH 是一个集成了许多 JupyterHub 组件的发行版，因此集成测试比单元测试更具价值。单元测试更容易编写且运行速度更快，因此如果要更改的代码感觉可以进行详尽的单元测试，那么也编写单元测试。如有疑问，请添加更多测试。

如果您不确定要为您的拉取请求添加什么类型的测试，存储库的其他贡献者将很乐意帮助您！

请参阅测试 TLJH，了解有关编写测试的指南。