docs(codereview): require design context for deep PRs - #550
Conversation
Co-authored-by: openhands <openhands@all-hands.dev>
…uide Main reorganized the review guide into blocking checkpoints since this branch was opened. Move the deep-PR design-context rules into that structure as one checkpoint, keep every acceptance criterion from #549, and use the risk levels the code-review skill already defines. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
all-hands-bot
left a comment
There was a problem hiding this comment.
This review was posted by an AI agent (OpenHands).
Scope: In scope for OpenHands/extensions. The change adds repository-local review guidance to .agents/skills/custom-codereview-guide.md, which this repository owns. Linked issue #549 is open and carries enhancement + ready-for-dev, so the work has a product/architecture direction and does not need to move repositories.
What I verified on head 701a545:
- The diff is exactly +31/-0 in one file; no other files changed.
- The
.pr/cleanup claim is accurate:.github/workflows/pr-artifacts.ymlrunscleanup-on-approvalonpull_request_reviewwithstate == 'approved'andhead.repo.full_name == github.repository, and itgit rm -rf .pr/. The new text's caution that a.pr/-only design page must not be auto-approved therefore matches the workflow's real behavior. - The HIGH/MEDIUM/LOW weighting matches
skills/code-review/SKILL.mdandreferences/risk-evaluation.md("a HIGH risk assessment requires a COMMENT ... do not approve it for automatic merge; LOW or MEDIUM risk alone does not justify withholding approval"). No contradiction with the general skill. - The guide does not claim
.agents/skills/pr-design-doc/exists; the directory contains onlycustom-codereview-guide.md. - Repo punctuation convention (plain hyphens, no em dashes) is respected in the added lines.
git diff --checkpasses andgrep -q '^triggers:'passes, as the PR states. No test asserts on this guide's content, so the prose change carries no regression risk.- Current-head checks for
701a545are green:pr-title,sync-extensions,validate-claude-code,sync-sdk-skill,test,check,check-pr-artifacts,package.cleanup-on-approvalisskipped(expected until an approval event fires).
Findings: None material. The guidance is specific and operational, is scoped to the extensions-owned contracts the issue names, and its acceptance criteria are each addressed by the added section.
Non-blocking note: The PR is still marked draft and the HUMAN: section of the template is unedited. That is a workflow/handoff concern owned by the deterministic event handler, not a defect in the change itself, so it does not affect this verdict.
Verdict: The change is a documentation-only addition to the repository review guide, is accurate against the repository's own machinery, and introduces no correctness, security, or compatibility risk. No material findings.
✅ APPROVED
|
🚀 Released in v0.28.0. |
HUMAN:
This PR proposes to request a design doc for deep enough changes; e.g. API changes or shared execution/loading or other contracts. The custom review guide request is similar with others in other repos.
AGENT:
Why
The extensions repository has the
.pr/artifact workflow but no repository-specific guidance on when a deep, high-risk change needs design context. Reviewers (human and automated) end up reconstructing intent from the diff, and an automated approval can delete the only.pr/design page before a human sees it. This adds that expectation to the repository review guide, scoped to extensions-owned contracts, without assuming a repository-localpr-design-docskill.Summary
.agents/skills/custom-codereview-guide.md: a new Design context for deep changes checkpoint under "Blocking checkpoints".code-reviewskill already uses..pr/page that is the only design explanation.main; the section was rewritten to fit the guide's restructuring in docs(review): define extension-specific checkpoints #611 and docs(review): define extensions repository scope #643.Issue Number
Fixes #549
How to Test
Ran in the PR worktree:
git diff --check grep -q '^triggers:' .agents/skills/custom-codereview-guide.mdBoth pass. Checked each acceptance criterion of #549 against the new section:
.agents/skills/pr-design-doc/exists here..pr/page that is the only design context blocks automated approval (approval triggerscleanup-on-approvalin.github/workflows/pr-artifacts.yml).This is review-guide text; it takes effect on the next reviewer run that loads the guide.
Video/Screenshots
Not applicable; no product UI change.
Notes
The general
code-reviewskill already withholds approval for HIGH risk; this checkpoint makes missing design context an explicit input to that decision for this repository.This pull request was created by an AI agent (OpenHands) on behalf of @enyst, and updated by an AI agent (Claude Code, Opus 5.5) helping Engel Nyst (@enyst).