Skip to content

Contributing

Guidance for contributors and maintainers working in this repository.

Start Here

Read the Development Guide first if you are setting up the repo, looking for the standard contributor workflow, or need the sandbox usage and local debugging guide for feature work.

Choose The Right Page

  • Development Guide — Read this if you need the canonical contributor workflow: local setup, sandbox usage, debugging/report URLs, validation commands, and CI-aligned day-to-day development.
  • API Versioning — Read this if you are changing JSON API behavior and need the canonical lifecycle and version-bump policy.
  • Discovery Architecture — Read this if you need the canonical reference for discovery, normalization, classification, and parameter resolution behavior.
  • Discovery Workflow Visual Reference — Read this if you want a visual companion to the discovery architecture document before or while reading the authoritative rules.
  • Frontend Assets — Read this if you are changing report JavaScript or CSS and need the canonical asset workflow and CI expectations.
  • Releasing — Read this if you are preparing or publishing a package release and need the canonical maintainer runbook.

Quick Reference

make setup          # env, install, migrate, sample data
make test           # run tests
make lint           # ruff check
make coverage       # run tests with coverage