# Contributing ## Setup Work inside the dev shell (`direnv allow` once). Version control is jj, not the `git` CLI. ## Before committing ```sh cargo clippy --workspace --all-targets cargo fmt --all ``` Clippy runs with the pedantic lints and forbids absolute paths; formatting needs the nightly toolchain the dev shell provides. ## Testing | What | Command | | --- | --- | | Model and render tests | `cargo test --workspace` | | Scripted demos | `cargo run --example boot` (also `shutdown`, `luks`) | | Sample machine in a window | `nix run .#sample-machine-vm` | | Boot and shutdown in a VM | `nix build .#checks.x86_64-linux.vm-boot-and-shutdown` | | Passphrase prompt in a VM | `nix build .#checks.x86_64-linux.vm-luks-passphrase` | To watch your own user manager start the sample units: ```sh units=$(nix build --no-link --print-out-paths .#sample-unit-files) systemctl --user link --runtime $units/* systemctl --user start --no-block bootvine-demo.target cargo run -- --user --target bootvine-demo.target --hold 3s systemctl --user stop $(ls $units) systemctl --user disable --runtime $(ls $units) ``` The VM checks read the console as text, hold the boot at fixed points and wait on marker files instead of sleeping. To step through one by hand, run `nix run .#checks.x86_64-linux.vm-boot-and-shutdown.driverInteractive` and call `test_script()`. Prefix VM and recording commands with `env -u LD_LIBRARY_PATH` when your shell exports libraries that clash with QEMU or Chromium. ## Repository tasks - `nix run .#record-screencasts` re-records the README animations from the scripted demos and copies the passphrase screenshot from the VM check. - `cargo xtask install --destdir