Skip to content

Contributing

Syed Ahmer Shah edited this page Oct 25, 2026 · 1 revision

The full guide is CONTRIBUTING.md. In short:

  1. Open an issue first for anything bigger than a small fix.
  2. Branch from main: feat/..., fix/..., docs/... or chore/....
  3. Add tests; run the checks in Developer Setup.
  4. Open a pull request. main takes pull requests only, squash-merged once backend, frontend, images and CodeQL pass.

House rules

  • Commit messages: short, imperative, no prefixes.
  • Every fact from outside the library needs an official source URL you have read.
  • API changes update backend/openapi.json and the generated frontend types in the same PR.
  • Page titles are 60 characters or less, descriptions 140 or less.
  • No new dependency without a reason; pin exact versions. No secrets in commits.

Data contributions

The most useful help is an official page for data that is not on file yet: session hours, settlement cycles or published holiday calendars. See Data Sources and Quality.

Security issues

Do not open a public issue. Follow SECURITY.md and use private vulnerability reporting.

Clone this wiki locally