拉取请求清单#
我们建议您在提交拉取请求之前,检查您的贡献是否符合以下指南
如果您的拉取请求是为了解决某个问题,请在拉取请求的标题中描述该问题,并在拉取请求的描述中提及问题编号。这将确保创建指向原始问题的链接。
注意
在 PR 标题中添加相关问题不会生成链接,因此这样做没有意义,因为没有人会记住问题编号。请在 PR 中提及所有相关问题,但请仅在 PR 描述中提及。
所有公共方法都必须具有信息丰富的文档字符串,并在适当时提供示例用法。文档字符串应遵循 numpydoc 风格
请在打开拉取请求时,在下拉菜单中选择“创建草稿拉取请求”,以表明工作正在进行中。这样做是为了避免重复工作,尽早获得关于实现细节或 API/功能的输入,或寻求合作者。
文档和高覆盖率测试是增强功能被接受的必要条件。
当添加额外功能时,请考虑在 pymc-examples 中添加一个示例 notebook。在示例仓库中打开一个 proposal issue,以讨论 notebook 的具体范围。
运行 pymc-examples 中任何已有的示例,这些示例包含可能受您的更改影响的分析,以确保没有任何问题。这是一个有用的机会,不仅可以检查您的工作是否存在可能无法通过单元测试发现的错误,还可以展示您的贡献如何为最终用户改进 PyMC。
没有
pre-commit
错误: 请参阅 Python 风格指南 和 Jupyter 风格指南 页面,了解如何安装和运行它。当一切从头开始重建时,所有其他测试都通过。请参阅 运行测试套件