docs(standards): document REVIEW.md as a required file - #92
Merged
Conversation
There was a problem hiding this comment.
No issues found.
Reviewed the RST changes in rst/guide/best-practices/standards.rst:
- Section underlines all meet/exceed title length (verified char counts).
:ref:labelreview-mddefined once and referenced twice — no duplicate/broken refs.- Enumerated list sequential (1–10); file-tree entry correctly placed.
list-table,.. important::, andcode-blockdirectives well-formed.- Documented severity levels and five-heading contract are consistent with this repo's own REVIEW.md.
Build success and ref resolution are correctly deferred to CI.
REVIEW.md is consumed by the AI review workflow and overrides generic best practices, but the guide never mentioned it — nobody setting up a repository learned it existed or which five headings it must carry. Signed-off-by: Simon Bärlocher <s.baerlocher@sbaerlocher.ch>
sbaerlocher
force-pushed
the
feat/review-md-standards
branch
from
August 9, 2026 10:17
25234a5 to
330e619
Compare
sbaerlocher
enabled auto-merge (squash)
August 9, 2026 10:17
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
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
REVIEW.mdto the required-files list and the recommended structure tree instandards.rst; it exists in seven arillso repositories with an identical five-heading structure but was documented nowhere.ai-claude-review.ymlinarillso/.githubreads it on every pull request and treats it as taking precedence over generic best practices..review-base/and ignores the copy at the repository root, so a pull request cannot rewrite the rules of its own review.Test plan
./build.sh) — not runnable in the authoring environment, left to CI:ref:targets resolve:review-mdis defined once and referenced from the workflow naming section and theseealsoblock