Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (45 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 2.11 KB
Raw

Contributing

Thanks for considering a contribution to physio-synth.

The project is still evolving, especially in its physiological assumptions and calibration. Useful contributions include code, tests, documentation, scientific references, and rational criticism of unrealistic signal behavior.

What Is Most Helpful

  • bug reports with a concrete reproduction;
  • pull requests with small, focused changes;
  • modeling feedback tied to physiology or biomedical literature;
  • improvements to validation criteria and tests;
  • documentation fixes when behavior, assumptions, or commands change.

Development Setup

Bootstrap the local environment:

uv sync --dev

Useful commands:

uv run physio-synth --days 3 --output output/vitals_research_dataset.csv
uv run ruff check .
uv run ruff format --check .
uv run pytest

Contribution Expectations

  • keep changes small and reviewable;
  • update tests with behavior changes;
  • update documentation when assumptions, commands, or outputs change;
  • preserve deterministic generation for a fixed configuration and seed unless the change is intentional;
  • prefer physiologically plausible modeling over visually convenient heuristics.

Modeling Changes

If you change the model, try to make the rationale explicit:

  • what behavior changed;
  • why the old behavior was insufficient;
  • whether the new behavior is literature-based, empirically calibrated, or heuristic;
  • which tests or validation checks cover the change.

For signal-specific notes, see:

Pull Requests

Before opening a pull request, make sure:

  • the code is formatted;
  • lint checks pass;
  • tests pass;
  • the README still matches the actual CLI and behavior.

If a change is intentionally incomplete, call that out clearly in the PR description.

License

By intentionally submitting a contribution to this repository, you agree that your contribution will be licensed under the repository license unless explicitly stated otherwise.