Contributing

Octomate is a uv workspace with three packages: the server in octomate/, the client CLI in cli/, and the shared contract in protocol/. The engineering rules live in the repository's AGENTS.md, which every agent and every reviewer reads; this section covers the mechanics and the extension points.

In this section

• Set up: clone, sync, a development database, the console.
• Checks and tests: what clean means, and how the suite is built.
• Repository layout: what lives where.
• A channel tentacle: a new chat platform.
• An agent tentacle: a new runtime.
• An MCP tentacle: rarely needed; configuration covers most.
• Documentation: the site's structure and how to keep it true.
• Releases: how the three packages ship.
• Plans and issues: how work is written up before it is built.

Two conventions worth knowing before the first diff. A change is landed in the order a reviewer reads it: schema and model, then managers, then call sites. And a migration is always autogenerated from the model, then adjusted; see Persistence.