Repository navigation
Contributing
Syed Ahmer Shah edited this page Oct 25, 2026
·
1 revision
The full guide is CONTRIBUTING.md. In short:
- Open an issue first for anything bigger than a small fix.
- Branch from
main:feat/...,fix/...,docs/...orchore/.... - Add tests; run the checks in Developer Setup.
- Open a pull request.
maintakes pull requests only, squash-merged oncebackend,frontend,imagesand CodeQL pass.
- 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.jsonand 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.
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.
Do not open a public issue. Follow SECURITY.md and use private vulnerability reporting.
MarketClock by Syed Ahmer Shah · MIT License · support@ahmershah.dev · The repository's docs/ are the source of truth.
Use it
Run it
Build it
Repository