Contributing¶

Thanks for contributing to Deep-UQ.

Development Setup¶

git clone https://github.com/Vispikarkaria/Deep-UQ.git
cd Deep-UQ
pip install -e ".[dev,tests]"
pre-commit install

Run Tests¶

pytest -q
ruff check .
black --check .
mypy

Optional Docs Build¶

pip install -e ".[docs]"
mkdocs build --strict

Optional Benchmarks¶

python benchmarks/run_benchmarks.py --preset quick

Pull Request Checklist¶

• Add or update tests for code changes
• Keep APIs backward compatible unless clearly versioned
• Update tutorials/docs if behavior changes
• Keep notebook code cells executable and syntactically valid

Coding Style¶

• Use clear names and simple control flow
• Add comments only when code is not self-evident
• Preserve stable return contracts in public wrappers