Skip to content

Commit e4662db

Browse files
feat: make docs staleness critical, streamline review output
- Doc staleness findings are now critical severity (release blocker) - Tighter summary template: severity counts on one line, no verbose sections (Files Reviewed, Verdict, Breaking Changes) - Inline comments kept to 2-3 sentences - Summary doesn't repeat inline comment details
1 parent 186522d commit e4662db

1 file changed

Lines changed: 13 additions & 18 deletions

File tree

skills/pr-review.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -220,10 +220,10 @@ Procedure:
220220
- D3: Credential requirements — Required API scopes or permissions changed (new OAuth scopes, different permission levels, new authentication methods).
221221
- D4: Configuration fields — Config fields added, removed, or renamed in pkg/config/config.go.
222222
223-
If any of D1-D4 apply, read docs/connector.mdx to confirm the specific section that would need updating.
223+
If any of D1-D4 apply, read docs/connector.mdx to confirm the specific section that would need updating. Documentation staleness is a critical blocker — the docs must be updated before merge.
224224
225225
Return a JSON object:
226-
{"status": "stale", "findings": [{"id": "D1", "section": "<section name in docs>", "reason": "<why it's stale>"}]}
226+
{"status": "stale", "findings": [{"id": "D1", "severity": "critical", "section": "<section name in docs>", "reason": "<why it's stale>"}]}
227227
228228
Or if none apply:
229229
{"status": "up_to_date"}
@@ -246,7 +246,7 @@ DIFFS:
246246
3. **Cross-validate entity sources** (if provisioning changed): Read the Grant/Revoke code yourself to verify P1/P2 findings. This is the #1 bug.
247247
4. **Cross-validate PR feedback**: Check PR review comments against findings. Add missing unaddressed items as warnings.
248248
5. Downgrade breaking changes gated behind config flags from critical → suggestion.
249-
6. Parse the docs-reviewer (Agent 4) result. If status is "stale", convert each finding to a warning.
249+
6. Parse the docs-reviewer (Agent 4) result. If status is "stale", convert each finding to **critical** severity — stale docs are a release blocker.
250250

251251
**Deliverable:** A merged list of findings (code + docs) with duplicates removed. Print the count of findings by severity.
252252

@@ -256,28 +256,23 @@ DIFFS:
256256

257257
Post findings directly as PR comments:
258258

259-
1. **Inline comments** on specific lines where issues are found, with the finding ID, severity, description, and recommendation.
259+
1. **Inline comments** on specific lines where issues are found. Keep each comment to 2-3 sentences: what's wrong, why it matters, and how to fix it.
260260

261-
2. **Summary comment** with ALL of the following sections (do not omit any):
261+
2. **Summary comment** — be concise. No more than a few sentences per finding. Use the following template (do not omit any section):
262262

263263
```
264264
### PR Review: <PR title>
265265
266-
### Findings
267-
| Severity | Count |
268-
|----------|-------|
269-
| Critical | N |
270-
| Warning | N |
271-
| Suggestion | N |
266+
**Critical: N | Warning: N | Suggestion: N**
272267
273-
### Breaking Changes
274-
<findings or "None detected.">
268+
### Critical Issues
269+
<one-liner per issue with file:line, or "None.">
275270
276271
### Documentation
277-
<output from docs-reviewer agent — docs staleness assessment>
272+
<one-liner: "Up to date", "No docs file", or which sections need updating and why>
278273
279-
### Files Reviewed
280-
| File | Category |
281-
|------|----------|
282-
| ... | ... |
274+
### Other Findings
275+
<brief list of warnings/suggestions, or "None.">
283276
```
277+
278+
Do NOT include a "Files Reviewed" section, a "Verdict" section, or a "Breaking Changes" section. Do NOT repeat findings that were already posted as inline comments — just reference them briefly in the summary. Keep the entire summary comment short.

0 commit comments

Comments
 (0)