Contributing

Set up the Cadence repo locally, run scoped tests, and open a pull request. MIT licensed.

Prerequisites

• Bun (exact version in .tool-versions).
• Linux or macOS. Linux sandboxing uses bwrap (bubblewrap). macOS uses sandbox-exec.
• Git.

Running from source

Clone Aevum-Project/cadence-assistant. bun install. Hatch a local assistant with the CLI. Do not point a PR at vendor origin if you are working the Aevum remote.

Testing

• Always pass file paths to bun test.
• Typecheck instead of running the whole suite.
• Regression tests for unfixed bugs use test.todo until the fix lands.

Style

• User-facing copy says assistant.
• No em dashes. Generic examples only (Alice, user@example.com, 555-0100).
• Wrap every if / else / loop body in braces in JS/TS we touch.
• Exact versions in package.json (no caret), MIT-compatible licenses only.

See Development workflow and Security.