Imported from tinyhumansai/medulla (
AGENTS.md). Install upstream withnpx skills add tinyhumansai/medulla. Copyright stays with the author.
Repository Guidelines
What this repository contains
This is the public Medulla repository. It contains the Rust client workspace, its vendored dependency submodules, tests and e2e harnesses, documentation, GitBook sources, installers, and release workflows. The hosted orchestration service is operated separately; do not add service-side implementation here.
crates/— the workspace crates:medulla-link, themedullaSDK, andmedulla-tui. Each product primitive gets its own crate here.vendor/— pinned source submodules used by the Rust workspace.docs/andgitbooks/— engineering specs and published documentation..github/,scripts/,e2e/, andexamples/— CI/release automation, development helpers, integration suites, and examples.
Working rules
- Make changes on a feature branch in a worktree. Run
worktree <slug>before editing and work inside the reported./worktrees/<slug>path. - Keep source, tests, docs, and workflows together when a change affects them.
- Preserve vendored dependency pins unless deliberately updating a dependency.
- Keep CI and release workflows usable with standard GitHub Actions permissions; never require organization-only secrets for routine builds or releases.
- Never commit secrets,
.envfiles, or machine-local configuration.
Checks
Initialize dependencies and developer tooling with make init. The primary
checks are:
cargo fmt --all -- --check
cargo clippy --locked --all-targets -- -D warnings
cargo test --locked
cargo build --locked --all-targets
Use make ci to run the full local gate. See DEVELOPING.md
and Contributing for the development
workflow.
