参与贡献#

欢迎贡献，我们非常感激你的参与！

贡献类型#

您可以通过多种方式做出贡献。

报告错误#

欢迎使用 GitHub Issues 来报告错误。

在向我们报告错误前，请先使用 main 分支的最新代码检查一下，也许该错误已修复。

报告错误时，请包含：

  • 你的操作系统以及操作系统的版本。

  • 你的 Python 版本。

  • 重现错误的步骤。

提交修改#

一旦你发现了一个可以修复的错误，欢迎向我们提交 Pull Request。

Please follow our git commit conventions.

优化文档#

Everyone wants a good documentation. There may be mistakes or things missing in the documentation, you're welcome to help us improving the documentation.

开发#

Once you cloned joserfc's source code, you can setup a development environment to work on.

venv#

强烈建议你使用 venv 创建一个虚拟环境：

python -m venv .venv
source .venv/bin/active

安装#

Then install the Python requirements for development:

pip install -r requirements-dev.txt

Run tests#

Once you made some code changes, you can add your test case in the tests folder, then verify it with:

pytest

下一步#