拉取请求检查清单#
我们建议您的贡献在提交拉取请求之前符合以下指南:
如果你的拉取请求解决了某个问题,请使用拉取请求的标题来描述该问题,并在拉取请求的 描述 中提及问题编号。这将确保创建一个返回原始问题的链接。
小心
在PR标题中添加相关问题不会生成链接,因此没有用处,因为没有人知道问题编号。请在PR中提及所有相关问题,但仅在PR描述中提及。
所有公共方法必须有信息丰富的文档字符串,并在适当的情况下提供示例用法。文档字符串应遵循 numpydoc 风格
在打开拉取请求时,请在下拉菜单中选择“创建草稿拉取请求”,以表明这是一个正在进行中的工作。这是为了避免重复工作,获取关于实现细节或API/功能的早期反馈,或寻求合作者。
文档和高覆盖率的测试是接受改进所必需的。
在添加额外功能时,考虑在 pymc-examples 中添加一个示例笔记本。在示例仓库中打开一个 提案问题 以讨论笔记本的具体范围。
运行 pymc-examples 中任何包含受你更改影响的分析的预先存在的示例,以确保没有任何问题。这是一个有用的机会,不仅可以检查你的工作中可能未被单元测试揭示的错误,还可以展示你的贡献如何改善 PyMC 对最终用户的体验。
没有
pre-commit
错误: 请参阅 Python 风格指南 和 Jupyter 风格指南 页面,了解如何安装和运行它。当所有内容从零开始重新构建时,所有其他测试都通过。请参阅 运行测试套件