评审者指南

警告

评审指南正在开发中。

分类

• 分配相关标签

• 分配到相关项目板

• 标题: 它使用的是三字母代码吗？它是否易于理解？

• 描述：是否可理解？是否有相关的问题/PR？

• CI 检查：首次贡献者的批准，代码/文档质量检查需要帮助吗？

• 合并冲突

代码

• 单元测试：代码更改是否经过测试？测试是否易于理解？所有更改是否都被测试覆盖？我们通常的目标是至少90%的测试覆盖率。代码覆盖率将作为GitHub上自动化CI检查的一部分以及在 Codecov网站 上报告。

• 在本地测试更改：一切是否按预期工作？

• 弃用警告：公共API是否发生了变化？在做出更改之前是否添加了弃用警告？

文档

• 文档字符串是否完整且对用户易于理解？

• 它们遵循 NumPy 格式和 sktime 约定吗？

• 如果在 sktime 的其他地方包含相同的参数、属性、返回对象或错误，请确保文档字符串的描述尽可能相似。

• 在线文档的更改是否正确呈现？

• 文档字符串是否包含指向 术语表 或 示例 中相关主题的链接？

警告

如果一个 Pull Request 不符合 sktime 的 文档指南 ，评审者应在批准 Pull Request 之前要求更新文档。