Contributing to cluv

Thank you for your interest in contributing to cluv!

Issues

Use GitHub Issues to report bugs or suggest features.

Clone and install project:

git clone https://github.com/mila-iqia/cluv
cd cluv
uv sync

Use your local version as the cluv tool:

uv tool install --editable <path_to_cluv_repo>

uv run pytest

Tests marked integration require live SSH connections to real clusters. Skip them locally:

uv run pytest -m "not integration"

uv run pre-commit run --all-files

Host a server to see changes in real time :

uv run mkdocs serve --livereload