docs: freeze the conformance contract (contract-v1)#78
Merged
Conversation
Elevate the Studio ⇄ toolkit conformance contract to a public, front-door doc and freeze it as the 0.5.0 baseline. - docs/CONTRACT.md: the trust story (two independent implementations, one format, CI-checked), what the contract covers (trace format, event model, session correlation, the 16-rule taxonomy — 4 critical / 10 warning / 2 info, 15 scenarios), how conformance is enforced (15/15 or a release is blocked), and the freeze + versioning policy (contract-v1 immutable; a change to detected output is a new version). Links to the vendored mechanics in src/ocpp/conformance/ rather than duplicating them. - docs/adr/0012-freeze-contract-v1.md: records the freeze decision, refining the versioning half of ADR-0001. - Cross-links: the README trust hook and cli-parity.md now point at CONTRACT.md; ADR index updated. Conformance unchanged and still green (15/15; `studio ci` exit 0). Closes #72.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Elevates the Studio ⇄ toolkit conformance contract to a public, front-door document and freezes it as the 0.5.0 baseline — the trust hook for the launch.
What's here
docs/CONTRACT.md— the public contract: the trust story (two independent implementations, one format, checked in CI on every change), what it covers (trace format, event model, session correlation, the 16-rule failure taxonomy — 4 critical / 10 warning / 2 info — and the 15 shared scenarios), how conformance is enforced (native test/studio ciassert Studio's failure-code set equals the toolkit-generated goldens; 15/15 or the release is blocked), and the freeze + versioning policy (contract-v1is immutable; any change to detected output is a new version). It links to the vendored fixtures/goldens/harness insrc/ocpp/conformance/rather than duplicating the mechanics.docs/adr/0012-freeze-contract-v1.md— records the freeze decision, refining the versioning half of ADR-0001.cli-parity.mdnow point atCONTRACT.md; the ADR index is updated.Docs only — no code change. The existing
src/ocpp/conformance/README.md(vendored mechanics + regeneration recipe) is unchanged;CONTRACT.mdis the public complement.Verification
Conformance unchanged and green —
studio ci→ 15/15, exit 0. All ofCONTRACT.md's relative links resolve.Closes #72.