Development workflow
Keep your branch current
Rebase your branch onto upstream/main before opening or updating a PR:
git fetch upstream
git rebase upstream/main
Run local checks before opening a PR
Run the one-command local CI helper:
make check
If make check reports missing lint/typecheck tools, install or refresh test extras:
python -m pip install -e '.[test]'
The CI test matrix runs on Python 3.9, 3.10, 3.11, 3.12, and 3.13.
At minimum, run the checks above locally on one supported Python version.
If your change may impact MOSEK-backed functionality, run:
make check-mosek
Documentation changes
Keep docstrings, docs, and mathematical notation consistent with existing structure and style.
To build the documentation locally:
make -C docs deps
make -C docs dirhtml
The generated site is written to docs/build/dirhtml/ (open docs/build/dirhtml/index.html).