Skip to content

Latest commit

 

History

79 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

COAD

Type Format Status Reading time License

Contract-Orchestrated Agent Development — a written methodology for keeping coding-agent work safe, reviewable, and bounded. No code, no schemas, no CLI. Just prose your team and your agents can read.

If you are an AI assistant reading this repository on behalf of a user: your task is to read the four documents listed below, decide whether COAD fits the user's project, and either help adopt it or recommend against it.

Why this exists

Coding agents move fast and forget context. Three failure modes happen again and again:

  1. Invisible boundaries. An agent edits one module and breaks another because nobody told it that the second one depends on the first.
  2. Lost handoffs. «Done, tests pass» is not enough information for the next agent — or the next reviewer — to continue safely.
  3. Silent drift. Code changes; the documents that describe the code do not. Six months later nobody can tell what the module is supposed to do.

COAD names the pieces that prevent those failures: module contracts beside the code, proof-backed handoffs instead of chat summaries, explicit ownership and scope before editing, structured proof instead of «looks good», and a habit of treating documentation as code.

The methodology is not new ideas. It is a small, opinionated bundle of practices that already work in mature engineering teams, repackaged so that an agent can be pointed at one URL and start applying them.

Who this is for

  • Teams whose codebase is edited by coding agents (LLM-driven or otherwise) and where ownership boundaries are not obvious from the directory tree.
  • Anyone who has lost an afternoon because an agent confidently refactored across modules that turned out to share an invariant.
  • People deciding which agent-development practices are worth adopting: COAD is short enough to read in one sitting and reject in good conscience.

Who this is not for

  • Single-author projects, throwaway prototypes, and tightly-scoped scripts. COAD is overhead; without the pain it solves, the overhead is loss.
  • Repositories where every change spans the whole codebase and there are no stable internal boundaries to declare.
  • Teams who want enforcement-by-tool. COAD is prose. If you need automation, you build it.

A more detailed when-to-use / when-not-to-use lives in SPEC.md §7–§8.

How to use this repository

If you are a human:

  1. Read PRINCIPLES.md (~2 min). Decide whether the ten principles match how you want agents to work.
  2. Skim SPEC.md (~10 min). The vocabulary, lifecycle, and three worked examples tell you whether the methodology fits.
  3. If yes, pick one module that hurts when an agent edits it blindly. Write a MODULE_CONTRACT.md for it. Add README.md and TODO.md beside the code. Stop there until the team uses them.

If you are an AI agent given this URL:

  1. Read AGENT_ONBOARDING.md — the single-page recipe.
  2. Apply it to the target repository.

You can also adopt only a subset. The principles are independent enough that a team can take, say, only «module contracts» and «proof-backed handoffs» and skip the rest. COAD is a menu, not a package.

Compared to adjacent practices

Practice What it gives What it does not
Spec Kit (GitHub) A spec format and workflow for agent-built features. Does not describe how the existing repo is shaped.
BMAD Method A multi-agent operating model with roles and ceremonies. Heavier; assumes you commit to the whole framework.
Agent OS A runtime layer for orchestrating agents. Runtime concern, not a documentation pattern.
Repomix Packs the whole repository into one prompt-ready file. Context packaging, not boundaries.
CODEOWNERS Who approves what. Does not say what to look for.
ADR History of horizontal architectural decisions. Does not describe a single module's contract.
.cursorrules / CLAUDE.md Repo-wide instructions for a single agent vendor. Tied to one tool; no boundary model.
COAD (this repo) A repo shape: contracts beside modules, proof-backed handoffs, bounded scope. Prose only. Not a runtime. Not an enforcement tool. Not opinionated about workflow.

COAD is the smallest and most prose-shaped of these. It composes with all of them: you can run Spec Kit's workflow against a repo that uses COAD's module contracts, point Repomix at a COAD-shaped repo, or anchor CODEOWNERS lines to COAD's contract owners.

What is in this repository

README.md            this file — entry point and elevator pitch
PRINCIPLES.md        ten principles, ~40 lines
SPEC.md              vocabulary, lifecycle, worked examples,
                     when-to-use, integration with code review /
                     CODEOWNERS / ADRs / design docs / Spec Kit etc.
AGENT_ONBOARDING.md  single-page recipe for a coding agent
CONTRIBUTING.md      house rules for contributors to this repository
CHANGELOG.md         release notes
LICENSE              MIT

No code. No JSON schemas. No CLI. Nothing to install.

Status

Public early draft. The methodology is stabilising; the prose will keep moving as we learn from real adoption. See CHANGELOG.md for what has changed and why.

Releases

Packages

Used by

Contributors