From 1d44ea5c45ab36a0566c67179d2d5f446ea34bcc Mon Sep 17 00:00:00 2001 From: "melodic-standards-sync[bot]" <300666570+melodic-standards-sync[bot]@users.noreply.github.com> Date: Fri, 13 Nov 2026 23:37:14 +0000 Subject: [PATCH] chore: sync standards components (2a22bda34f1fabc74a01610cd9846e9c8a28f27a) --- REVIEW.md | 104 ++++++++++++++++++++++++++---------------------------- 1 file changed, 50 insertions(+), 54 deletions(-) diff --git a/REVIEW.md b/REVIEW.md index eb752fd..19f2934 100644 --- a/REVIEW.md +++ b/REVIEW.md @@ -1,22 +1,22 @@ # Review instructions -Managed Code Review injects this file verbatim as the highest-priority -instruction block for every review agent. It does not expand `@` imports and -does not read a cited file into the prompt. It sees only the words printed -below (see "Depth"). A self-hosted or local review running the `review` -plugin reads this file too, and additionally follows its citations into the -`standards` repository for the full reasoned criterion behind each line. - -Review in this organization is split into two mutually exclusive scopes, -so a finding belongs to exactly one scope and is never reported twice. -The **code-review lane** (`pr-review`, and Managed Code Review) -reads this file and applies the code-review scope below. The **security -lane** (`pr-review-security`) runs from its own security-only prompt -rather than reading this file; its scope section below records the same -split for every surface that does read it, so the code-review lane -knows what to leave to the security lane, and so a self-hosted or local -review (for example a `review`-plugin security agent) applies the right -section. +Managed Code Review gives every review agent this file's contents as the +repository's review instructions. Its citations, the +`standards/review/.md#` paths in parentheses, are not include +lines, so Managed Code Review does not read the cited files and sees only the +words printed below (see "Depth"). A self-hosted or local review running the +`review` plugin also follows each citation into the `standards` repository +for the full criterion behind the line. + +Review in this organization splits into two mutually exclusive scopes, so a +finding belongs to exactly one and is never reported twice. The **code-review lane** +(`pr-review`, and Managed Code Review) reads this file and applies the +code-review scope below. The **security lane** (`pr-review-security`) runs +from its own security-only prompt, not this file; the security scope below +records the split for every surface that does read this file, so the +code-review lane knows what to leave to the security lane, and a self-hosted +or local review (for example a `review`-plugin security agent) applies the +right section. ## Severity @@ -30,31 +30,30 @@ surface's three markers: | Important | 🔴 Important | | Suggestion | 🟡 Nit | -🟣 Pre-existing is not an SSOT severity. It is this surface's own +🟣 Pre-existing is not an SSOT severity: it is this surface's own detection-time judgment of whether a finding predates the diff, orthogonal -to the three-tier vocabulary above and not something a criterion assigns. +to the three severities above, and no criterion assigns it. -A finding tagged `blocking` is always 🔴 Important here, regardless of what -severity its underlying criterion would otherwise carry in context. -`blocking` is this file's own tag, not a severity a `standards/review/` -criterion assigns. +A finding tagged `blocking` is always 🔴 Important here, whatever severity its +criterion would otherwise carry in context. `blocking` is this file's own +tag, not a severity a `standards/review/` criterion assigns. ## Depth -Managed Code Review cannot resolve a citation below: `@` imports are not -expanded and cited files are not read into the prompt. A self-hosted or -local review using the `review` plugin can follow one into the full -criterion, its severity nuance, and its sources. A citation is a path of the -form `standards/review/.md#`, resolved relative to wherever -the `standards` checkout root is available: this repository's own root when -`standards` reviews itself, or the `--add-dir` mount root everywhere else. - -When the reviewed repository has a `docs/review/README.md`, that file indexes -the repository's own per-concern review criteria, and a self-hosted or local -review also reads the files there whose concern the change touches. Those -paths resolve against the reviewed repository's root, not the `standards` -checkout or its `--add-dir` mount. A repository without `docs/review/` is -reviewed as before. +Managed Code Review does not follow a citation below: a citation is not an +include line +([Include other files in REVIEW.md](https://code.claude.com/docs/en/code-review-customize#include-other-files-in-review-md)), +so the cited file never reaches the review. A self-hosted or local review +using the `review` plugin follows one into the full criterion, its severity +nuance, and its sources, resolving the path from the `standards` checkout +root: this repository's own root when `standards` reviews itself, or the +`--add-dir` mount root everywhere else. + +A reviewed repository's `docs/review/README.md`, when present, indexes its +own per-concern review criteria, and a self-hosted or local review also +reads the files there whose concern the change touches. Those paths resolve against +the reviewed repository's root, not the `standards` checkout or its +`--add-dir` mount. ## Code-review lane scope @@ -63,21 +62,18 @@ design, conventions, error handling, observability, tests, and documentation. On a repository whose CI runs the security lane (a `.github/workflows/pr-review-security*.yml` workflow exists), it does **not** report security findings, such as vulnerabilities, authorization -or tenancy gaps, credential exposure, or injection: every security -finding belongs exclusively to that lane and is omitted here even when a -hunk plainly contains one. -On a repository with no such workflow no security lane exists yet, and -suppressed findings would have no other reader: report security findings -under this lane too, applying the security-scope checks below. +or tenancy gaps, credential exposure, or injection: each belongs to that +lane alone and is omitted here even when a hunk plainly contains one. +On a repository with no such workflow, no other lane would report them: +report security findings here too, applying the security-scope checks below. Always check: - A high-risk security action, such as authentication, an authorization - failure, a privilege change, or sensitive-data access, has a - corresponding audit-log - entry (`standards/review/observability.md#logging`). This is an - observability completeness check on the logging seam; whether the action - itself is safe is the security lane's question. + failure, a privilege change, or sensitive-data access, has a matching + audit-log entry (`standards/review/observability.md#logging`). This checks + logging completeness; whether the action itself is safe is the security + lane's question. - A change that writes two or more related records, files, or state locations carries an atomicity mechanism spanning them: a transaction, an atomic rename, a constraint, or a compensation step. An @@ -86,20 +82,20 @@ Always check: - No Dependabot pull request waits on a human. One whose updates are all non-major, with GitHub Actions only from `actions/*`, `github/*` or `anthropics/*`, and none in the policy's `reviewOnly` security-critical - list, merges once `ci-status` passes; any other, a major included, merges + list, merges once `ci-status` passes. Any other, a major included, merges on an AI review lane's `merge` verdict at its current head once `ci-status` passes, and a verdict on a security-critical dependency cites - the threat-model control it checked. A change that adds an action from another - publisher says why no vendor action or `gh` or script step serves + the threat-model control it checked. A change that adds an action from + another publisher says why no vendor action or `gh` or script step serves (`components/dependabot-policy/README.md#merge-tiers-for-dependabot-pull-requests`). ## Security lane scope This lane reports **only** security findings: vulnerabilities, missing authorization or tenant scoping, exposed secrets or credentials, injection, -and their direct enablers. Everything else is out of scope here and is -owned by the code-review lane; omit it. That includes style, design, -correctness with no security impact, and test coverage. +and their direct enablers. Everything else, including style, design, +correctness with no security impact, and test coverage, belongs to the +code-review lane; omit it. Always check: