Skip to content

how to contribute

Douwe de Vries edited this page Jul 2, 2026 · 2 revisions

How to contribute

Contributors should keep the shared backend, browser transport, desktop transport, and tests in sync. Most changes touch at least one Rust workflow, one frontend type or component, and one test file.

Work pickup

  1. Read architecture to identify the runtime boundary.
  2. Find the relevant subsystem in systems or features.
  3. Add or update tests near the behavior: root Rust integration tests under tests/, Tauri tests under src-tauri/src/, or frontend Vitest tests under frontend/src/.
  4. Run the validators listed in getting started.

Definition of done

  • Behavior is implemented through shared workflows in src/backend/workflow.rs when both runtimes need it.
  • Browser API routes and Tauri invokes remain aligned, as described in transport parity.
  • New request/response fields are represented in Rust and TypeScript types.
  • Tests cover success and failure paths that users can hit.
  • Release metadata is updated only for actual release work, not for docs-only changes.

Review expectations

Reviewers should check data flow, error shape, transport parity, and stale UI workflow handling. The conventions page explains these patterns in patterns and conventions.

Clone this wiki locally