|
| 1 | +# {{project_name}} Protocol |
| 2 | + |
| 3 | +This document is downstream from Keel and should describe the protocol surfaces that external systems, peer reactors, and operators rely on when coordinating work with {{project_name}}. |
| 4 | + |
| 5 | +## Downstream Contract |
| 6 | + |
| 7 | +Use this file for stable coordination rules and data contracts, not for local implementation details. |
| 8 | + |
| 9 | +Mission Stack coordination is part of the formal protocol surface. It should be documented here as an explicit contract rather than left as chat lore or repo-local habit. |
| 10 | + |
| 11 | +## Protocol Scope |
| 12 | + |
| 13 | +Hydrate the protocol surfaces that matter in this repository: |
| 14 | + |
| 15 | +- ingress requests from humans, agents, or upstream systems |
| 16 | +- repo-to-repo handoff receipts |
| 17 | +- lifecycle acknowledgments and checkpoint signals |
| 18 | +- file, API, webhook, or queue payloads that other systems consume |
| 19 | + |
| 20 | +## Mission Stack Coordination |
| 21 | + |
| 22 | +Mission Stacks are a formal Keel protocol for cross-repo execution. |
| 23 | + |
| 24 | +- Each participating repository remains authoritative for its own `{{board_dir}}/` state. |
| 25 | +- Cross-repo work should flow through explicit stack negotiation and handoff rather than direct mutation of another repo's planning artifacts. |
| 26 | +- Stack-linked work should use `stack/<id>` as the coordination branch unless this repo intentionally documents a narrower rule here. |
| 27 | +- Foreign execution in another member repo should happen through a managed worktree rather than that repo's primary checkout. |
| 28 | +- Hydrate any repo-specific checkpoint, receipt, approval, or cleanup expectations here. |
| 29 | + |
| 30 | +## External Ingress |
| 31 | + |
| 32 | +Describe how outside work enters {{project_name}}: |
| 33 | + |
| 34 | +- accepted request shapes |
| 35 | +- validation and acknowledgment |
| 36 | +- how requests materialize into local mission lineage |
| 37 | +- rejection or retry behavior |
| 38 | + |
| 39 | +## Data Contracts |
| 40 | + |
| 41 | +Document stable contracts that other systems rely on: |
| 42 | + |
| 43 | +- input shapes |
| 44 | +- output shapes |
| 45 | +- receipt or acknowledgment fields |
| 46 | +- versioning or migration expectations |
| 47 | + |
| 48 | +## Local Exceptions |
| 49 | + |
| 50 | +If {{project_name}} intentionally narrows or extends Keel's default protocol rules, document those deviations explicitly here. |
0 commit comments