Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 1.13 KB

Contributing

We welcome contributions to the project. Please follow the guidelines below.

Development environment

We use uv to manage the development environment.

Setup a virtual environment (once):

uv sync

Testing

Use pytest to run the unit checks:

uv run pytest .

and

uv run --resolution lowest-direct pytest .

to test against the lower bounds of dependencies.

Linting

We use ruff to lint the code. Run the following command to check the code:

uv run ruff check . --fix --show-fixes

Type checking

We use ty to statically type check the code.

uv run ty check src/ tests/ examples/

Check all files

Recommended before creating a commit: to run all checks against all files,

run the following command with prek:

uv run prek -a .

Build the documentation

To build the documentation, run the following command:

uv run sphinx-build -M html ./docs ./docs/_build -W --keep-going

Test that all examples run

for s in examples/*.py; do uv run $s; done