Skip to content

Contributing

Contributions are welcome. Bug reports, feature requests, and pull requests are all appreciated.

  • Rust 1.94.0+ with edition 2024
  • A Tauri v2 app for testing (or use the examples)
  • Linux (WebKitGTK) — macOS/Windows not yet supported
Terminal window
git clone https://github.com/mpiton/tauri-pilot.git
cd tauri-pilot
cargo build --workspace
cargo test --workspace
  • No .unwrap() outside of tests — use thiserror (plugin) or anyhow (CLI)
  • Clippy strict: cargo clippy --workspace -- -D warnings
  • Modules < 150 lines, functions < 50 lines
  • Edition 2024, rust-version 1.94.0
  1. Fork the repo and create a feature branch from main
  2. Write tests first (TDD: RED → GREEN → REFACTOR)
  3. Implement the minimum to pass tests
  4. Run cargo test --workspace && cargo clippy --workspace -- -D warnings
  5. Commit with conventional messages: feat(plugin): ..., fix(cli): ...
  6. Open a PR against main

Use one of the following scopes in your commit messages:

ScopeArea
plugincrates/tauri-plugin-pilot
clicrates/tauri-pilot-cli
bridgecrates/tauri-plugin-pilot/js/bridge.js
protocolJSON-RPC protocol definitions
workspaceRoot Cargo.toml, workspace config
docsDocumentation
ciGitHub Actions workflows

Use the issue templates on GitHub — bug reports and feature requests are welcome.

MIT