Skip to content

how to contribute

Douwe de Vries edited this page Jul 1, 2026 · 1 revision

How to contribute

Work in this repository usually crosses the React workspace, the typed Tauri API, and the Rust backend. Keep the TypeScript models in src/lib/loadrift/types.ts aligned with the Rust models in src-tauri/src/models.rs.

Pickup checklist

  1. Read Getting started.
  2. Run npm install and npm run install:k6.
  3. Use npm run tauri dev for end-to-end desktop work.
  4. Add or update tests near the code being changed.
  5. Run the relevant validators before opening a PR.

Definition of done

Area Expected check
Frontend style npm run lint
TypeScript contract npm run typecheck
React behavior npm test
Rust behavior cd src-tauri && cargo test
Rust compile cd src-tauri && cargo check
Release-sensitive work Review .github/workflows/ci.yml, .github/workflows/release.yml, and src-tauri/tauri.conf.json

Review focus

Pay special attention to command names, event payloads, state transitions, and secret handling. The frontend adapter in src/lib/tauri/client.ts must match command registrations in src-tauri/src/lib.rs, and events in src-tauri/src/events.rs must match constants in src/lib/loadrift/api.ts.

For coding conventions, see Patterns and conventions.

Clone this wiki locally