1.3 KiB
1.3 KiB
Contributing
Development setup
# Arch Linux
pacman -S uv just
# optional
pacman -S just-lsp yamlfmt shellcheck typos
The development environment and testing requires multiple specific Python versions; they can be installed with (inside the pulled git project directory):
uv sync
The storage directory of Python versions can be configured with UV_PYTHON_INSTALL_DIR. (It must be an absolute path.)
Testing
A script is available to run the test suit.
just test
Formatting
Formatting of YAML files requires yamlfmt to be installed separately.
A script is available to run the format check.
just format-check
just schema-check
Linting
Linting requires shellcheck to be installed separately.
Validating pyproject.toml against the checked-in uv schema also requires
jq.
Spell checking requires typos to be installed separately.
A script is available to run the lint check.
just lint-check
just type-check
Documentation
A script is available to run the documentation generation.
just docs