Files
reporting-governance-plugin/plugins/continuity/README.md

64 lines
1.4 KiB
Markdown

# Continuity Plugin (MVP)
This package is the skeleton for extracting the current approved-plan continuity hard gate into an installable plugin.
## MVP status
- Task 2: package skeleton created
- Task 3: config schema contract scaffolded
- Task 4: config validation tests added
- Task 5: minimal config validator implemented
- Task 6: receipt validator contract extracted
- Plugin evaluator / adapter logic intentionally not implemented yet
## Layout
```text
plugins/continuity/
README.md
README.zh-TW.md
HOOK.md
package.json
examples/
src/
test/
```
## Planned public surface
- `src/config/schema.mjs`
- `src/config/defaults.mjs`
- `src/continuity/evaluator.mjs`
- `src/continuity/receipt-validator.mjs`
- `src/adapters/force-recall.mjs`
- `src/index.mjs`
## Example config
See `examples/openclaw.continuity.example.json`.
## Receipt validator contract
The MVP receipt validator currently defines this minimum shape:
- `planId`
- `currentTask`
- `nextDerivedAction`
- `dispatchedAt`
- `dispatchRunId`
- `childSessionKey`
- `replyClosureState`
API surface:
- `validateReceipt(receipt)`
- `isValidReceipt(receipt)`
See `src/continuity/types.md` for the extracted contract note.
## Notes
- Current terminal states preserved by default: `waiting_user`, `blocked`, `pending_verification`
- Default receipt directory target: `state/approved-plan-continuity`
- `npm test` is reserved for the full plugin test suite defined by the implementation plan