diff --git a/.agents/skills/custom-codereview-guide.md b/.agents/skills/custom-codereview-guide.md index 87f144db..f76b25bb 100644 --- a/.agents/skills/custom-codereview-guide.md +++ b/.agents/skills/custom-codereview-guide.md @@ -13,6 +13,45 @@ Review whether a PR belongs in this public extensions registry. Skills, plugins, If a PR is opened in the wrong repository, explicitly recommend that it may need to be closed and moved to the repository that owns the change rather than merged here. Apply the repository's contribution and review guidance to every PR. +## Design Docs for Deep PRs + +A diff shows line-level edits, not always the design: intent, contract shape, +before/after behavior, compatibility, and why the approach fits. Expect concise +design context for a deep PR that a reviewer cannot fully judge from the diff in +a couple of minutes, for example: + +- a new or changed skill, plugin, automation, integration contract, or manifest + schema; +- a new subsystem, cross-cutting refactor, or migration; +- a behavior change in shared loading, validation, discovery, or execution; or +- a large diff whose intent is difficult to hold at once after generated files, + lockfiles, snapshots, vendored code, and mechanical churn are excluded. + +Skip this for trivial or self-explanatory changes such as typos, one-line guards, +dependency bumps, small documentation edits, and localized fixes. Line count is +a signal, never a gate by itself. + +When a deep PR lacks adequate design context, weigh the omission against risk: + +- **🔴 HIGH risk:** do not approve. Submit **COMMENT** and request design context + before a human merge decision. +- **🟡 MEDIUM risk:** use judgment; withhold approval when reconstructing the + design from the diff would materially slow or weaken review. +- **🟢 LOW risk:** never block solely on missing design context. + +Design context may be an available design-doc artifact or a durable write-up in +the PR description. An equivalent write-up must state the intent, important +before/after behavior or contract shape, compatibility and risk, and grounded +code references. + +The `.pr/` workflow removes temporary artifacts after a same-repository approval. +If a temporary `.pr/` page is the primary design explanation, do not submit an +automated approval until a human maintainer has reviewed it, unless the PR +already contains the durable equivalent context above. Leave a **COMMENT** so the +artifact remains available for the human decision. + +A design doc aids review; it does not excuse correctness, security, architecture, +or repository-ownership problems. ## SDK Documentation Placement