Document the usage report contents and add a coverage decision - #5944
Open
johnsimons wants to merge 1 commit into
Open
johnsimons wants to merge 1 commit into
johnsimons wants to merge 1 commit into
Conversation
Adds a catalog (`docs/usage-report.md`) that lists every key the usage report carries, every setting deliberately left out, and the reason for each exclusion. Also adds an architectural decision record explaining why the report should cover every setting or runtime choice rather than adding keys on demand. The catalog is the authoritative reference for analysis and the enforcement point for review: a pull request that adds a setting must either add a key or add an exclusion row, or it gets a review finding.
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.
Adds a catalog (
docs/usage-report.md) that lists every key the usage report carries, every setting deliberately left out, and the reason for each exclusion. Also adds an architectural decision record explaining why the report should cover every setting or runtime choice rather than adding keys on demand.The catalog is the authoritative reference for analysis and the enforcement point for review: a pull request that adds a setting must either add a key or add an exclusion row, or it gets a review finding.