-
Notifications
You must be signed in to change notification settings - Fork 0
how to contribute development workflow
The local loop uses Bun for scripts, Cargo for Rust, Vite for the renderer, and Tauri for the desktop shell. Commands are declared in package.json.
bun install --cwd frontend
bun run dev
bun run verify:fastbun run dev enters src-tauri and runs cargo tauri dev. bun run verify:fast runs the checks most useful before a small commit: frontend typecheck, frontend lint, frontend tests, frontend dist guard, cargo fmt --all --check, and cargo clippy --workspace --all-targets -- -D warnings.
For a change to Session, Entry, Draft, Finding, Attachment, AI Run, or settings data:
- Update the relevant file under
crates/qa-scribe-core/src/domain. - Update persistence in
crates/qa-scribe-core/src/storage/mod.rsorcrates/qa-scribe-core/src/services/session_service. - Update command registration or DTO exports in
src-tauri/src/specta_bindings.rsif the bridge changes. - Regenerate or check
frontend/src/bindings.tswithbun run bindings:generateorbun run bindings:check. - Update frontend wrappers in
frontend/src/tauri.tsandfrontend/src/tauriCommands.tswhen command signatures change.
Most UI changes start in frontend/src/app/AppShell.tsx, a view under frontend/src/views, or an action factory under frontend/src/app. Shared rich-record behavior lives in frontend/src/views/RichRecordView.tsx and frontend/src/views/RecordCollectionView.tsx.
See Patterns and conventions for naming, validation, and bridge patterns.
- QA Scribe
- Download overview video (MP4)
- Architecture
- Getting started
- Glossary
- By the numbers
- Lore
- Fun facts
- Video overview
- How to contribute
- Development workflow
- Testing
- Debugging
- Patterns and conventions
- Tooling
- Applications
- Desktop app
- Smoke harness
- Systems
- Rust core
- Tauri command bridge
- Frontend shell
- Generation jobs
- Provider detection
- Release tooling
- Features
- Session capture
- Rich record editing
- Managed attachments
- AI-assisted Testware
- Settings and provider setup
- Crates
- qa-scribe-core
- qa-scribe-app
- Primitives
- Session
- Entry
- Finding
- Draft
- Evidence
- API
- Tauri commands
- Deployment
- Security
- Background
- Architecture decisions
- Migration context
- Cleanup opportunities
- TODOs and FIXMEs
- Complexity hotspots
- Reference
- Configuration
- Data models
- Dependencies