Driver contract template¶
Status: Draft
Version: 0.1
1. Identity¶
- driver_id:
- driver_family:
- supported profiles:
- supported platforms:
2. Purpose¶
- responsibilities:
- non-goals:
3. Interface¶
3.1 Context¶
Define required context fields and constraints.
3.2 Request¶
Define required request fields and constraints.
3.3 Result¶
Define result fields, including exit code semantics and output paths.
4. Execution rules¶
- tool selection and version pinning expectations
- idempotency expectations
- retries and timeouts
5. Evidence¶
Minimum evidence set:
- context snapshot (redacted)
- request snapshot (redacted)
- subprocess results (argv, rc, duration)
- outputs inventory (non-secret paths)
6. Security¶
- secret injection rules
- redaction rules
- filesystem permission requirements
7. Compatibility¶
- supported versions and constraints
- upgrade notes
8. Change control¶
Breaking changes require an updated driver contract and migration guidance.