Contributing¶
uv sync --all-extras # every extra + the dev group (test, lint, docs)
uv run pytest
uv run ruff check src tests
uv run mkdocs build --strict # docs must build without warnings
uv run mkdocs serve
- Docstrings: NumPy style. Write equations as LaTeX (
$...$,$$...$$) and make such docstrings raw (r"""..."""). - Library code (
core,generation,stats,sampling,utils) stays free of UI imports; seetests/test_architecture.py. - Report issues at https://github.com/rcalderonb6/class-e/issues.