pr-explainer
A pull request explained for reviewers: what changed and why, a before and after, risks and the test plan, and a guided tour of the files, drawn from the branch commits and diff.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 1.1k
- Forks
- 104
01 前言 Front Matter
- od
- { "mode": "prototype", "craft": { "requires": [ "typography", "typography-hierarchy", "color", "accessibility-baseline" ] }, "preview": { "type": "html", "entry": "index.html" }, "platform": "desktop", "scenario": "engineering", "design_system": { "requires": false }, "example_prompt": "Explain the current branch as a pull request for reviewers: what changed and why, a before and after, risks and how it was tested, and a tour of the files in the order to review them." }
- name
- pr-explainer
- tags
- [ "pull request", "pr", "code review", "changes", "diff", "engineering" ]
- emoji
- 🔍
- en_name
- PR Explainer
- zh_name
- PR 说明
- category
- doc
- scenario
- engineering
- triggers
- [ "pr explainer", "explain this pr", "pull request description", "explain my changes", "review guide", "walk me through this branch" ]
- description
- A pull request explained for reviewers: what changed and why, a before and after, risks and the test plan, and a guided tour of the files, drawn from the branch commits and diff.
- en_description
- A pull request explained for reviewers: what changed and why, a before and after, risks and the test plan, and a guided tour of the files, drawn from the branch commits and diff.
02 资源文件 1
- 其他.od-local-overlay82 B
03 SKILL.md 正文
PR Explainer
Intent. Helps a reviewer understand a change in five minutes and review it in the right order. It is a guide to the diff, not a copy of it.
Ground it
Write only what the sources say. Gather them yourself before writing a word:
git log --oneline <base>..HEADandgit diff --stat <base>...HEAD(base:mainunless the user says otherwise);git diff <base>...HEAD -- <path>for the files that matter, and the tests that changed;- if
ghis available and a PR exists,gh pr view --json title,body,files,commitsand linked issues.
Keep the list of files, commits and refs you read: they go in a Sources section at the bottom of the page and in sources when you register (register_open_design_artifact with kind html). If something the document needs isn't in the sources, ask the user, or mark it plainly as an open question. Never invent numbers, dates, names or quotes.
Structure
- Header: PR title, branch → base, author, number of commits and files,
+added −removed. - In one paragraph: what this changes and why, for someone who won't read further.
- Before and after: the behaviour before and after, side by side. For UI changes, screenshots: render the before and after with the export tool and embed the images. For other changes, a short example (a command and its output, an API call).
- Risks: what could break, and how the change guards against it.
- How it was tested: the tests added or changed (by name), and manual checks.
- Review tour: the files in the order to review them, grouped (core logic first, then call sites, then tests, then generated or mechanical changes), each with one line on what to look for. Mechanical changes (generated files, renames) are listed together so reviewers can skim them.
- Sources: the commit range and the files read.
Design
- One readable column (
max-width720–780px), body 16–17px with line-height 1.55–1.65, generous space between sections. It must read well on a phone: tables sit in anoverflow-x: autowrapper, nothing has a fixed width wider than the screen. - Style from the active design system (
--bg,--surface,--fg,--muted,--border,--accent); status colours are the only extra colours (green for accepted/done, amber for proposed/in progress, red for rejected/high severity, grey for superseded). - Headings are short labels; the content does the talking. Code, paths and commands in a monospace face, with
overflow-wrap: anywhereso long paths wrap on phones. - Finish with
check_open_design_artifactand fix every error at desktop and mobile width.
04 同仓库更多 Skills
youtube-clipper
YouTube clip generation and editing with automated workflows — pull source video, slice highlights, add captions, and export.
writing-guidelines
Review docs/prose for Writing Guidelines compliance. Use when asked to "review my docs", "check writing style", "audit prose", "review docs voice and tone", or "check this page against the writing handbook".
wpds
WordPress Design System. Apply WordPress's official design tokens, typography, and component patterns to themes and sites.
weread-year-in-review-video-template
WeRead-inspired HyperFrames video template for vertical annual reading reports, personal reading dashboards, book-note recaps, and shareable year-in-review stories. Use when users want a 9:16 HTML-to-MP4 reading report with warm paper texture, editorial Chinese typography, book-page metaphors, data highlights, and deterministic motion.
web-design-guidelines
Review UI code for Web Interface Guidelines compliance by the Vercel engineering team. Covers layout, typography, color, motion, and accessibility for product UI.
web-clone
网站复刻 / 克隆方法论。USE WHEN 用户说 复刻网站、克隆网站、clone website、抄个站、仿站、 照着这个站做一个、reproduce site、还原某个网页效果、把这个站搬下来改成我的、 复刻某个交互/WebGL/Canvas/Three.js 效果。提供「先拿真源码 → 判路径 → 逆向拆解 → 搭工程 → 替换内容」的可移植决策树,覆盖静态站 / React-Vue-Next 内容站 / WebGL-Canvas 重前端站三大分支,并强制核对任何 AI 二手分析里的可执行代码。