Skip to content
Browse documentation

Contribute to LOR.

Start with a focused issue and propose a small change whose result others can reproduce.

On this page

1. Choose an issue

Read open issues and their acceptance criteria. Comment before starting to prevent duplicate work. Wait for prerequisites on issues marked blocked.

2. Create a branch

Branch from main using feat/issue-number-short-slug or fix/issue-number-short-slug. Use Conventional Commits for commit messages.

3. Verify and open a PR

Run typecheck, lint, tests, and build. Check UI changes in Arabic and English on mobile and desktop. Open a small PR linked to the issue with verification steps.

Project invariants

Never persist keys or make a call depend on AI. Caption changes need WER and code-switch preservation results.

Checks before opening a pull request

npm run typecheck
npm run lint
npm test
npm run build
npm run check:docs

The two-person call test exists, but hosted CI currently skips it. Run it for media changes when disposable LiveKit and Postgres are available; use no production data.