参与贡献#

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

贡献类型#

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

报告错误#

欢迎使用 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.

安装#

Install uv and use Python 3.11 or newer. Create the development environment from the committed uv.lock file:

uv sync --locked

uv creates and manages .venv automatically. Dependency groups are defined in pyproject.toml; the dev group is installed by default. Install the documentation dependencies with:

uv sync --locked --group docs

When changing dependencies in pyproject.toml, update and commit uv.lock:

uv lock

Use uv lock --upgrade-package <name> to update a specific dependency.

Run tests#

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

uv run --locked pytest
uv run --locked ruff check
uv run --locked mypy

Build documentation#

uv run --locked --group docs make build-docs -e lang=en