Project

Contributing

Contribute focused changes with tests, clear documentation, stable events, and clean package responsibilities.

Development workflow

Use the Node version in .nvmrc, install repository dependencies, add tests for exported behavior, and run the full repository check before requesting review.

shell
corepack enable
pnpm install --frozen-lockfile
pnpm check
pnpm test:browser:install
pnpm test:browser

How this code works

  1. 01
    Enable the package manager

    Corepack selects the pnpm version declared by the repository.

  2. 02
    Install dependencies

    pnpm restores the exact workspace dependency graph from the lockfile.

  3. 03
    Run repository checks

    pnpm check covers formatting, lint, types, package builds, unit behavior, and rendered documentation.

  4. 04
    Install browser engines

    Playwright uses pinned Chromium, Firefox, and WebKit binaries for repeatable fixtures.

  5. 05
    Run browser checks

    pnpm test:browser checks keyboard behavior, focus, structure, and browser updates.

Review expectations

Keep core independent of browsers, DOM independent of React and AI frameworks, and adapters small. Never claim that an automated transcript or page update proves what a screen reader spoke.

  • Every exported API requires tests and documentation.
  • Every owned timer and subscription must be disposed.
  • All queues and tracked identities remain bounded.
  • Security reports follow SECURITY.md rather than public issues.