Tier 18.2: post-audit guardrails README (docs only) - #25
Merged
Conversation
Adds guardrails/README.md - maintainer-facing operational guide
to the validator suite. Documents:
- The 8 validators (purpose, allowlist file, scope notes)
- The 4 allowlist CSV files and their post-audit state
(known_field_mapping_gaps.csv at 0 rows; 3 others retaining
intentional deferred items)
- The shared utilities (_ddl_parser.py, test__ddl_parser.py,
spec_pins.json, pre-commit)
- How to add new allowlist entries if a future audit cycle
uncovers gaps
- How to close an allowlisted gap (delete the row; validator
verifies)
- The two failure modes the Tier 18.1 parser fixed
- Post-audit state and references to institutional-knowledge
documents
Pure docs addition. Complements rather than replaces the existing
VERIFICATION_PROTOCOL.md (which is the policy document).
Verification:
- All 8 guardrails still pass (no behavior change).
- 10/10 regression tests pass.
- Audit-tracked backlog (known_field_mapping_gaps.csv) at 0.
5 tasks
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
Pure docs addition:
guardrails/README.md- a maintainer-facing operational guide to the validator suite. Closes followup item #2 from the post-audit list.Files changed
guardrails/README.md(NEW) - operational referenceCHANGELOG.md- Tier 18.2 entryWhat the README covers
_ddl_parser.py,test__ddl_parser.py,spec_pins.json,pre-commitCOMMENT 'string'Why
With the F3.1/F3.2 backlog closed (Tier 17.5) and the validator regex hardened (Tier 18.1), the guardrails suite is in a steady-state. Capturing the operational knowledge in a maintainer-facing README protects future readers from having to reconstruct the audit closure history from CHANGELOG entries scattered across Tiers 13-18.
Complements (rather than replaces) the existing
guardrails/VERIFICATION_PROTOCOL.md, which is the policy document. The new README is the operational reference.Verification
test__ddl_parser.pystill pass.known_field_mapping_gaps.csv) remains at 0 rows.Open followups remaining
Test plan
test__ddl_parser.pyregression tests pass