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, so we agree on the approach.
- Branch from
main:feat/...,fix/...,docs/...orchore/.... - Add tests with every feature. Run the checks in Developer Setup before pushing.
- Open a pull request using the template.
mainonly takes pull requests; they are squash-merged once CI (backend, frontend, CodeQL) passes.
- Commit messages: short, imperative, no prefixes ("Add overlap tool", not "feat: added...").
- API changes update
backend/schema.ymland the generated frontend client in the same PR. - Every user-facing string goes through translation (
t("key")in React,gettextin Django), in English, Urdu and Arabic. Use logical CSS properties so right-to-left layouts work. - Public pages work without JavaScript, and motion is off under
prefers-reduced-motion. - No new dependency without a reason in the PR; pin exact versions.
- No secrets,
.envfiles, dumps or personal data in commits. - Comments only for what the code can't say: why, a library quirk, a trap.
Urdu and Arabic strings were drafted and still need a native speaker's review. If you speak
either language, corrections are very welcome: open an issue or a pull request against the .po
files in backend/locale/ or the JSON files in frontend/src/i18n/.
Do not open a public issue. Follow SECURITY.md and use private vulnerability reporting.
HolidayOps 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