为该项目做出贡献

我们希望使对这个项目的贡献尽可能简单和透明。

拉取请求

我们积极欢迎您的拉取请求。

  1. 分叉仓库并从master创建你的分支。

  2. 如果您添加了应该被测试的代码,请添加测试。

  3. 如果您更改了API,请更新文档。

  4. 确保测试套件通过。

  5. 确保你的代码通过了代码检查。

本地运行测试

在提交拉取请求之前,请确保测试套件通过。 您可能需要在test/中修改或添加新的测试用例。

要安装测试依赖项,请运行 pip install "openbox[test]"pip install -r requirements/dev/test.txt

要在本地运行测试:

pytest -rap test

查看每个测试用例的输出:

pytest -rap --durations=20 --verbose --capture=tee-sys test

问题

我们使用GitHub问题来跟踪公共错误。请确保您的描述清晰,并提供足够的说明以便能够重现问题。

我们提供初学者友好的问题模板,帮助您入门。 尝试填写问题

许可证

通过向本项目贡献,您同意您的贡献将根据此源代码树根目录中的LICENSE文件进行许可。