Contributing
We welcome contributions!
Development Environment
-
Install
uv: See astral.sh/uv. -
Clone the Repository:
bash git clone https://github.com/jultou-raa/GraphMDO.git cd graph-mdo -
Install Dependencies (including dev):
bash uv sync --all-extras --dev
Code Style
We use ruff for linting and formatting.
- Check:
uv run ruff check . - Format:
uv run ruff format .
Running Tests
Tests are written using pytest.
uv run pytest tests/
Ensure you have 100% test coverage before submitting a PR.
Documentation
To build and preview documentation locally:
uv run mkdocs serve
Documentation source files are located in docs/.