Files
element-call-Github/AGENTS.md
T

4.1 KiB

AGENTS.md — Element Call

MatrixRTC (MSC4143) + LiveKit video calling, shipped standalone, as a widget in Element Web and Element X, as embedded packages, and as a React component in a host's page. It is the MatrixRTC reference implementation.

Non-negotiables

  • Features and UI changes need a pre-approved issue. No issue, no review.
  • Exactly one PR-* label per PR. CI enforces it; it drives the changelog.
  • New behaviour ships with unit tests, a story if it renders, and an e2e spec if it is user-facing. All three.
  • Reuse an existing component. If you genuinely cannot, say so in the PR body and name what you rejected — never add a new one silently.
  • Nothing reads the page. No window.location, document.body, window.inner*, @media, global i18next or the widget global — take it from a provider.
  • The change works standalone, as a widget and as a component. Say what you checked.
  • Every gate below is green before you push.

Read before you

… …
touch call logic or a view model docs/agents/architecture.md
write any code docs/agents/code-style.md
write a test, story or e2e spec docs/agents/testing.md
open a PR CONTRIBUTING.md

Scratch files live in agent-workspace/

Git-ignored. One kebab-case subfolder per task, matching the branch topic: agent-workspace/<slug>/.

File Purpose
plan.md The concrete approach — files, symbols, edit order — once direction is confirmed
commit-msg.txt git commit -F agent-workspace/<slug>/commit-msg.txt
pr-body.md gh pr create --body-file agent-workspace/<slug>/pr-body.md
implementation-summary.md What was built, decisions, trade-offs
NN-prompt.md Raw prompt text, numbered, when worth keeping
  • Nothing here is durable. The folder is ignored, so anything worth keeping is promoted into the PR body or a doc before the task ends.
  • Never write scratch files to the repo root. Stray load_test_summary.md and config.json_ files are what this folder prevents.
  • Start pr-body.md from .github/PULL_REQUEST_TEMPLATE.md and fill every section.

Gates

pnpm lint            # tsc, oxlint, knip, component externals
pnpm format          # oxfmt
pnpm test            # vitest: unit and storybook projects
pnpm i18n:check

knip fails on dead code; a file deliberately inert ahead of its consumer goes in knip.ts ignoreFiles with a reason.

Ready means every gate is green and the change is covered at the layers testing.md asks for. Read the diff against code-style.md first. Re-run the whole checklist after any fix.

A good PR

  • One slice, under ~400 changed lines, green on its own, linked to its issue.
  • View model + marble tests, thin view, a story per state, an e2e spec.
  • Any new shared component called out explicitly, with why nothing existing fit.
  • Template filled for real: what, why, before/after screenshots, repro steps.
  • Comments only where the code can't give the reason — see code-style.md.
  • Anything that redraws continuously — an animation frame, a stream — says what it costs, or better, counts the redraws in a test.
  • Branch <handle>/<topic>. Plain imperative commit subjects, no prefixes.
  • Once review starts, fix forward. Never force-push a regeneration over a review.