Describe the CI JSON validation accurately in the README - #243
Merged
Conversation
The PR gate does not run JSON-schema validation; it checks JSON well-formedness with jq and runs spec/validate.py (registry/spec cross-reference and shape checks). Correct the README claim to match the workflow. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates README documentation so it accurately describes what the PR-gate CI validates, aligning the repo's claims with the actual checks performed in .github/workflows/test-pull-request.yml.
Changes:
- Replaces the README's claim of "JSON-schema validation" with a description of the current JSON validation approach (
jqwell-formedness +spec/validate.pycross-reference/shape checks). - Clarifies the CI gate is lint-only and lists the lint/validation tools involved.
The jq well-formedness loop covers repo-config/ alongside registry/ and spec/; list all three so the description matches the workflow. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
Replace 'well-formedness' (an unknown word to cspell) with plain wording; content unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Pieter Viljoen <ptr727@users.noreply.github.com>
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
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.
The README claimed the PR gate runs "JSON-schema validation", but the workflow only runs
jq empty(well-formedness) +spec/validate.py(cross-reference/shape checks) - no schema validation. Corrected to match the actual CI (quantitative-claims rule). Surfaced by the 2.0 promotion review.🤖 Generated with Claude Code