Document JSON output conventions - #8754
Open
gonzaloriestra wants to merge 1 commit into
Open
gonzaloriestra wants to merge 1 commit into
gonzaloriestra wants to merge 1 commit into
Conversation
github-actions
Bot
added
the
no-changelog
gonzaloriestra
marked this pull request as ready for review
October 5, 2026 12:08
dmerand
approved these changes
Oct 5, 2026
This branch has not been deployed
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
2 participants
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.
WHY are these changes introduced?
Give the JSON-adoption skill a canonical set of conventions so command outputs use consistent shapes, field names, values, and error behavior.
WHAT is this pull request doing?
Document the agreed conventions for CLI and Hydrogen outputs, including resource and collection wrappers, identifiers, timestamps, missing values, outcomes, environment batches, files, and native-format exceptions. Update the schema examples and output-boundary testing guidance.
Require all changes needed to follow the conventions: use a major changeset for breaking an existing JSON contract, and a minor changeset for a new command or JSON flag.
Checklist
pnpm changeset add