Skip to content

docs(review): state the nit cap in its own per-concern review file #12198

Description

@kyle-sexton

Refs: #7583

Why: #7583's Decision "the nit cap lives in its per-concern file (Q570)" is the one decision of that issue not yet delivered. No file under docs/review/ or REVIEW.md caps nits today. The only nit text is the severity row | Suggestion | 🟡 Nit | at REVIEW.md:31.

Summary

Add a per-concern review file that limits how many Suggestion-severity findings (🟡 Nit in REVIEW.md's severity table) a single review posts. Then index it in docs/review/README.md with a trigger that fires on every review. REVIEW.md is synced from melodic-software/standards and stays unchanged. Its "Depth" section already points self-hosted and local reviews at docs/review/README.md.

Fix

  1. Create docs/review/findings.md with a # Findings heading and this rule as one list line, in the shape of the other files in docs/review/ (rule text, then a link):
    • A review posts at most five Suggestion-severity findings (🟡 Nit), choosing the five with the most consequence. It reports how many more it found as a count in the summary, and posts none of them inline. Critical and Important findings, blocking findings, and manifest <field>: flag lines are never capped: Code Review: Choose what to write in REVIEW.md.
  2. Add one row to the table in docs/review/README.md, directly under the REVIEW.md row:
    | [`findings.md`](findings.md) | anything: how many findings one review posts |
  3. Leave REVIEW.md unchanged. A change there is melodic-software/standards work, which standards: per-concern standards layout #7583 marks as an owner stop.

Basis:

  • The cap moves to a per-concern file: owner answer Q570 (poteto-review interview ledger) and standards: per-concern standards layout #7583's Decisions.
  • The number five comes from the upstream example, not from an owner decision. https://code.claude.com/docs/en/code-review-customize (read 2026-11-01) has "Report at most five Nits per review." under the "Cap the nits" heading of its example REVIEW.md, and, under "Choose what to write in REVIEW.md", says a cap of five nits "keeps reviews actionable".
  • The excess is reported as a count: judgment. The upstream page does not say what happens to nits past the cap; the poteto-review research draft recommends "report nits as a count" for incremental reviews, and a count keeps the dropped volume visible without posting it.
  • A new file and not pull-requests.md: judgment. pull-requests.md covers author-side post-PR triage, and the index loads a file only when the change touches its concern, so a cap there would not load on most reviews.
  • The CI code-review lane (plugins/review/skills/code-review/SKILL.md, "High-signal bar") already excludes style nits; this rule does not change that skill.

Done when

  • docs/review/findings.md exists, and grep -n "at most five Suggestion" docs/review/findings.md prints one line.
  • grep -n "count" docs/review/findings.md prints the line saying the findings past the cap are reported as a count in the summary.
  • grep -n "never capped" docs/review/findings.md prints the line exempting Critical, Important, blocking and manifest <field>: flag findings.
  • grep -n "code-review-customize" docs/review/findings.md prints the rule line's upstream link.
  • grep -n "(findings.md)" docs/review/README.md prints one table row whose second column starts with anything.
  • git diff --quiet origin/main -- REVIEW.md exits 0.
  • grep -cP '\x{2014}' docs/review/findings.md docs/review/README.md prints a count of 0 for each file (no em dash).
  • git diff --name-only origin/main lists only docs/review/findings.md and docs/review/README.md.

Verification

Run the grep and git commands in Done when against the PR head.

Related

Activity

  1. added
    priority: mediumReal value, no hard deadline; normal backlog flow.
    status: readyTriaged, unblocked, and fully specified; eligible to pick up.
    agent-readyFully specified and briefed; eligible for autonomous pickup from the frontier.
    work-class: scopedA briefed fix or small feature; blast radius bounded by the brief, tests exist.
    on Nov 2, 2026
  2. added theissue type on Nov 2, 2026
  3. melodic-automation-lanes commented on Nov 2, 2026

    @melodic-automation-lanes
    Contributor

    This records a re-fire of an earlier refusal, not a new refusal. The lanes kill switch stopped run 41369888632, the work-resolve-issue run that agent-ready started, before it did any work; that run ended at 2026-11-02T01:18:57Z. work-unblock has now removed and added agent-ready back to start a fresh run. A kill-switch refusal is no fault in this issue or the lanes, so it never counts against later re-fires; after limits.limit-stops-per-issue of them since a person last added agent-ready or a run last reported, work-unblock waits longer before each one, up to 24 hours.

  4. added
    agent-readyFully specified and briefed; eligible for autonomous pickup from the frontier.
    and removed
    agent-readyFully specified and briefed; eligible for autonomous pickup from the frontier.
    on Nov 2, 2026
  5. github-actions commented on Nov 2, 2026

    @github-actions
    Contributor
    No description provided.
  6. melodic-automation-lanes commented on Nov 2, 2026

    @melodic-automation-lanes
    Contributor

    This records a re-fire of an earlier refusal, not a new refusal. The lanes kill switch stopped run 41374154413, the work-resolve-issue run that agent-ready started, before it did any work; that run ended at 2026-11-02T02:23:18Z. work-unblock has now removed and added agent-ready back to start a fresh run. A kill-switch refusal is no fault in this issue or the lanes, so it never counts against later re-fires; after limits.limit-stops-per-issue of them since a person last added agent-ready or a run last reported, work-unblock waits longer before each one, up to 24 hours.

  7. added
    agent-readyFully specified and briefed; eligible for autonomous pickup from the frontier.
    and removed
    agent-readyFully specified and briefed; eligible for autonomous pickup from the frontier.
    on Nov 2, 2026
  8. github-actions commented on Nov 2, 2026

    @github-actions
    Contributor
    No description provided.
  9. github-actions commented on Nov 2, 2026

    @github-actions
    Contributor
    No description provided.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent-readyFully specified and briefed; eligible for autonomous pickup from the frontier.priority: mediumReal value, no hard deadline; normal backlog flow.status: readyTriaged, unblocked, and fully specified; eligible to pick up.work-class: scopedA briefed fix or small feature; blast radius bounded by the brief, tests exist.

    Type

    Fields

    No fields configured for Task.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions