Engineering guide
Rust conventions for Castellan contributors. Guardrail enforcement lives in governance policies.
Toolchain
- Pin via
rust-toolchain.toml - Format:
cargo fmt --all - Lint:
cargo clippy --workspace --all-targets -- -D warnings
Verification
Before every PR, run the full contributor gate (fmt, clippy, hack, tests, smoke benches, docs):
./scripts/verify.sh
castellan drift-check
Details: Verify before PR. Operators who only run Castellan day-to-day should follow Daily driver instead — that path uses castellan drift-check, not ./scripts/verify.sh.
Crate boundaries
| Crate | Responsibility |
|---|---|
castellan-core | Types: Goal, EpisodeLog, topology |
castellan-runtime | Scheduler, engine, MCP hot path |
castellan-events | Unified observability schema |
castellan-cli | Operator surface |
castellan-multiplexer | PTY + socket API |
Docs
- Published book (
book/src/) is canonical for operators — castellan-docs.sgoldbeg.workers.dev docs/holds engineering specs; see docs/INDEX.md- Do not link raw GitHub
docs/blobs from book pages — use relative book links