docs(validation): add codeowner severity guide, contributor guide, and architecture overview#382
Open
hdamker wants to merge 2 commits into
Open
Conversation
…d architecture overview Splits RM#485 across the two documentation trees by audience: a user-facing severity-obligations page for codeowners (documentation/validation/, linked from the README and pull-requests.md), plus a contributor guide and an architecture overview mapping the ReleaseManagement design documents to the implementation (validation/docs/).
rartych
approved these changes
Jul 21, 2026
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
3 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.
What type of PR is this?
documentation
What this PR does / why we need it:
Adds the three documentation pieces tracked under camaraproject/ReleaseManagement#485: a user-facing page explaining what each severity (error/warning/hint) obligates an API team to do and why the same rule can report differently as an API's status advances (
documentation/validation/severity-obligations.md, linked from the README andpull-requests.md); a contributor guide for adding or modifying a validation check (validation/docs/contributor-guide.md); and an architecture overview mapping the ReleaseManagement design documents to this repository's implementation modules (validation/docs/architecture-overview.md).Which issue(s) this PR fixes:
No tooling issue — implements camaraproject/ReleaseManagement#485.
Special notes for reviewers:
The severity-obligations page intentionally avoids rule-metadata internals (
conditional_level,override, engine names) peruser-documentation-guidelines.md's scope for the user-facing tree; the contributor guide and architecture overview are the admin/dev-facing counterparts undervalidation/docs/.Changelog input
Additional documentation
This section can be blank.