审阅者指南

警告

审阅者指南正在开发中。

分类处理

• 分配相关标签

• 分配到相关项目看板

• 标题：是否使用了三字母代码？是否易于理解？

• 描述：是否易于理解？是否有相关的议题/拉取请求？

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

• 合并冲突

代码

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

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

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

文档

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

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

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

• 在线文档是否能正确渲染这些更改？

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

警告

如果拉取请求不符合 sktime 的文档指南，审阅者应要求在批准拉取请求之前更新文档。