pr-review-format

Solid

Required format and rules for writing any pull request (PR) review comment — verdict line, section structure, materiality filter, safety carve-out. Load BEFORE composing or posting a PR review.

Code & Development 40 stars 7 forks Updated today MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
54
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# PR review format Review comments contain **nothing outside this structure** — no preamble, header, or emoji — except the footer: - First line: exactly `LGTM` or `Needs Updates`. - **Materiality filter:** drop trivia only — style/naming nits, subjective preferences, micro-optimizations, edge cases with no realistic trigger, anything you'd prefix "minor"/"nit". Never mention dropped trivia. Don't drop substantive non-blocking findings — route them to `### Recommended Optional` or `### Create Follow-up Issue`. - **Safety carve-out (overrides materiality and confidence):** anything touching money, data integrity, security, or auto-protective mechanisms is always surfaced; if unconfirmable, put it under `### Requires Human Review`. - **Verdict keys off blocking sections only:** `### Needs Fixing` and `### Requires Human Review` block; `### Recommended Optional` and `### Create Follow-up Issue` don't. `Needs Updates` iff ≥1 blocking item; otherwise `LGTM` (even when non-blocking findings follow the LGTM line). - `LGTM` means the reading agent may merge and close. With no findings at all, `LGTM` stands alone above the footer. - **LGTM precondition:** inspect every changed file and check CI status first. If you couldn't, emit `Needs Updates` and record the gap under `### Requires Human Review`. - Every finding goes under exactly one H3 section (omit empty ones). Sections are numbered lists; each item: **bold one-sentence title**, newline, description with critical details (`file:l...

Details

Author
richkuo
Repository
richkuo/rk-skills
Created
3 weeks ago
Last Updated
today
Language
JavaScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category