Huskies project-local agent guidance

Documentation

Docs live in website/docs/*.html (static HTML), not Markdown files. When a story asks you to document something, edit the relevant .html file in website/docs/.

Configuration files

Agent config: .huskies/agents.toml (preferred) or [[agent]] blocks in .huskies/project.toml
Project settings: .huskies/project.toml
Bot credentials: .huskies/bot.toml (gitignored — never commit)

Frontend build

The frontend is embedded into the Rust binary via rust-embed. Run npm run build in frontend/ before testing frontend changes, or the embedded assets will be stale.

Quality gates (all enforced by `script/test`)

npm run build (frontend)
cargo fmt --all --check
cargo clippy -- -D warnings
cargo test
npm test (frontend Vitest)

Clippy is zero-tolerance: no warnings allowed. Fix every warning before committing.

File size

Target a maximum of 800 lines per source file as a soft guide. If a file grows beyond 800 lines, decompose it by concern into smaller modules. Split at natural seams: group related types, functions, or handlers together and move each cohesive group to its own file. This keeps files readable and diffs focused.

Runtime validation

The validate_agents function in server/src/config.rs rejects unknown runtimes. Supported values: "claude-code" and "gemini". Adding a new runtime requires updating that function.

1.4 KiB Raw Blame History