Skip to main content

Contribute

You do not have to write code to help: clinicians telling us where a workflow is wrong is the most valuable help of all. For code:

  1. Open an issue first for anything bigger than a small fix, and agree the approach.
  2. Branch from main: feature/<name> or fix/<name>. Never commit to main directly.
  3. Sign every commit with git commit -s (Developer Certificate of Origin).
  4. One change per pull request, with its screen, its API and its tests together. A backend change ships its UI.
  5. Define permissions first, in Rust. See permissions.
  6. Document as you go: every function gets a doc comment, and every decision a row in medbrains/docs/DECISIONS.md in the same PR.
  7. Make the checks pass and say in the PR what changed, why, and how you checked it. Link the issue with Closes #123.
Never commit real patient data

Use only synthetic data in code, tests, seeds, screenshots and issues.

The full rules are in CONTRIBUTING.md and ENGINEERING.md.