docs: update validation framework design for hint field split and bundling clarification#463
Draft
hdamker wants to merge 3 commits intocamaraproject:mainfrom
Draft
docs: update validation framework design for hint field split and bundling clarification#463hdamker wants to merge 3 commits intocamaraproject:mainfrom
hdamker wants to merge 3 commits intocamaraproject:mainfrom
Conversation
Clarifies the two-field model per DEC-018: message_override replaces the engine message entirely (rare), hint adds fix guidance alongside the preserved engine message (common case).
Standalone API specs are bundled on the snapshot branch and included in the auto-generated source archive. No separate release asset needed.
YAML parses unquoted "off" as boolean False, causing silent bugs in rule metadata processing. Renamed to "muted" which is YAML-safe.
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.
What type of PR is this?
documentation
What this PR does / why we need it:
Two follow-up clarifications to the validation framework documents merged in #447:
Detailed Design: Split the single
hintfield in the rule metadata model into two fields:message_override(optional): replaces the engine message entirely when it is insufficienthint(optional): additional fix guidance rendered alongside the preserved engine messageThis separates "what's wrong" (message) from "how to fix it" (hint) cleanly. Updated sections 1.1, 1.3, 7.3, 8.4.1, 9.1, and 9.3.
Release Workflow Concept: Clarified that standalone API specs are already included in the auto-generated source archive (bundled on the snapshot branch), removing the "later phase" annotation.
Which issue(s) this PR fixes:
Related to #448 (validation framework umbrella)
Special notes for reviewers:
Draft PR — surfacing the changes early, not requesting review yet.
Changelog input
Additional documentation