docs(contracts): add machine-readable output contract reference#44
Merged
docs(contracts): add machine-readable output contract reference#44
Conversation
Document the public machine-readable surfaces for gitrole so scripts, agents, and future maintainers have an explicit contract to rely on. Also: - add a dedicated reference page for: - `gitrole status --short` - `gitrole doctor --json` - `gitrole resolve --json` - define field meanings, value vocabularies, and exit codes - document what is considered stable vs descriptive - clarify that contract changes to these machine-readable surfaces are breaking changes - document role-name constraints for stable key/value output Docs only. No CLI logic changes.
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
Add a dedicated machine-readable contract reference for
gitrole’s publicautomation surfaces.
Changed
gitrole status --shortgitrole doctor --jsongitrole resolve --jsonstatus --shortkey/value output remains unambiguousWhy
These outputs were already being treated like stable public contracts in tests
and team intent, but the repo did not yet document them explicitly. This page
makes the contract visible to users, agents, and future maintainers.
Notes