Skip to content

Contributing

For the full contributing guide — development setup, coding conventions, testing, PR checklist, and CLA — see CONTRIBUTING.md in the repository root.

Quick Reference

# Clone and set up
git clone https://github.com/microsoft/winml-cli.git
cd winml-cli
uv sync --extra dev
uv run pre-commit install

# Download runtime check rules (required for `winml analyze`)
gh release download <tag> --repo microsoft/winml-cli --pattern 'rules-v*.zip' --dir .
Expand-Archive -Path .\rules-v*.zip -DestinationPath src\winml\modelkit\analyze\rules\runtime_check_rules -Force

# Run tests
uv run pytest tests/ -m "not e2e and not npu and not gpu"

# Lint and format
uv run ruff check src/ tests/ --fix
uv run ruff format src/ tests/

# Docs preview
uv run mkdocs serve

See also