Skip to content

Contributing to Risk Bridge

Thank you for helping improve Risk Bridge! This guide outlines the development workflow and contribution expectations.

Issue Tracker

  • Bug reports, feature suggestions, and questions belong on GitHub Issues.
  • Please search existing issues before creating a new one.

Local Development Setup

We use uv for fast, reproducible dependency resolution:

# 1. Clone your fork or the repository
git clone https://github.com/SaehwanPark/risk-bridge.git
cd risk-bridge

# 2. Sync all dependencies (including dev and docs groups)
uv sync --locked --group dev --group docs

# 3. Run the test suite
uv run pytest

# 4. Check type safety
uv run basedpyright

# 5. Build and preview documentation locally
uv run mkdocs serve

Guidelines for Pull Requests

  1. Focused Scope: Keep PRs focused on a single change or bugfix.
  2. Test Coverage: All modifications to likelihood math, constraints, or calibration must be accompanied by focused unit tests.
  3. Documentation: Keep documentation in sync. If modifying API signatures or CLI arguments, update the corresponding markdown pages in docs/.
  4. Clean Builds: Ensure uv run pytest, uv run basedpyright, and uv run mkdocs build --strict pass with zero warnings before opening a PR.
  5. Privacy Guardrail: The public repository contains only privacy-safe synthetic cases. Never submit private or identifiable patient-level data.