ContributingTesting

Before you push

Run the checks of each part that you changed: Rust, the dashboard and the docs.

What you changed gives what you run

Terminal

cargo fmt --all --check
cargo clippy --workspace --all-targets -- -D warnings
cargo test --workspace

If your change touches Docker, builds, the proxy or the engine, also run FERRY_E2E=1 cargo test for the crates that you changed.

If web/ changed, run these commands in web/:

Terminal

npm test
npm run typecheck
npm run lint
npm run build

If a command, a flag, a route or a DTO changed, run these commands in docs/:

Terminal

npm run generate
npm run build

If tokens.css changed

The dashboard and the docs share web/src/styles/tokens.css. Build the two projects again.

Check the docs site

Three commands in docs/ check the types, the links and the generated reference pages.

Web client

The dashboard is a single-page app in web/. Vite serves it in development, and ferryd serves it in production.