docs: add versioned CLI capture matrix contract - #257
Open
harshitethic wants to merge 3 commits into
Open
harshitethic wants to merge 3 commits into
harshitethic wants to merge 3 commits into
Conversation
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.
Summary
Adds the first machine-readable + human-readable capture matrix for the CLI hook adapters, scoped to Claude Code and OpenAI Codex as requested in #239.
What changes
docs/capture-matrix.jsondefines provider setup/config/rollback, privacy notes, known gaps, and per-capability coverage.docs/capture-matrix.mdgives the reviewer-facing version of the same boundaries.tests/test_capture_matrix.pykeeps provider IDs unique, enforces the coverage schema, checks the human docs mention every machine-readable provider, and prevents an entry from claimingverifiedwithout a tested version, verification date, and fixture/test reference.Trust boundary
The current repository documents adapter behavior, but it does not contain a clean-environment verification record with exact Claude/Codex versions. This PR therefore marks both entries
unverifiedrather than fabricating version/date evidence. The structure makes that missing evidence visible and gives a deterministic place for #239's future verification command to update.For Codex, the matrix intentionally does not claim session-end/stop coverage because the current integration docs only claim session start, prompts, responses, and PreToolUse/PostToolUse activity.
Scope
This is a focused foundation for #239, not a claim to close the full issue. The remaining work is the executable setup/doctor verification path and automated stale-entry checks tied to real provider-version fixtures.
Validation
The added test is dependency-free (
unittest+ stdlib JSON/pathlib). I could not run the local suite because the connected development machine is offline; upstream CI is the verification gate for this branch.Refs #239.