docs: define automation compatibility policy

This commit is contained in:
Eric Wendland 2026-07-05 17:51:06 +02:00
commit 97e9daa118
4 changed files with 137 additions and 8 deletions

View file

@ -86,13 +86,13 @@ behavior.
Goal: make command, JSON, and protocol contracts explicit enough for scripts
and downstream projects.
- `[ ]` Define compatibility policy.
- `[x]` Define compatibility policy.
Acceptance criteria:
- `[ ]` CLI command compatibility is documented.
- `[ ]` `--json` output compatibility is documented.
- `[ ]` Local control JSONL compatibility is documented.
- `[ ]` Peer wire protocol compatibility is documented.
- `[ ]` SQLite and signed-operation compatibility are documented.
- `[x]` CLI command compatibility is documented.
- `[x]` `--json` output compatibility is documented.
- `[x]` Local control JSONL compatibility is documented.
- `[x]` Peer wire protocol compatibility is documented.
- `[x]` SQLite and signed-operation compatibility are documented.
- `[ ]` Add golden JSON tests.
Acceptance criteria:
@ -101,13 +101,13 @@ and downstream projects.
failures.
- `[ ]` Fixture updates require intentional review.
- `[ ]` Expand protocol roundtrip tests.
- `[~]` Expand protocol roundtrip tests.
Acceptance criteria:
- `[ ]` Every `ControlRequest` and `ControlResponse` variant roundtrips.
- `[ ]` Every `PeerControlRequest` and `PeerControlResponse` variant
roundtrips.
- `[ ]` Pipe and overlay wire protocol variants roundtrip.
- `[ ]` Unknown or malformed protocol inputs fail safely.
- `[x]` Unknown or malformed protocol inputs fail safely.
- `[ ]` Classify command stability.
Acceptance criteria: