pr-human-review-guide

Generate a structured PR review guide with reading order and prioritized comments.

1|Updated Apr 15, 2024

Search Tags:#pr #annotations #pull-request #structure-analysis #reading-order #review-guide #validation-notes

Ready to run

npx skills add https://github.com/yiminllin/dotfiles --skill pr-human-review-guide

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: pr-human-review-guide
Source: https://github.com/yiminllin/dotfiles/tree/main/opencode/.config/opencode/skills/pr-human-review-guide
Command: npx skills add https://github.com/yiminllin/dotfiles --skill pr-human-review-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps human PR reviewers by generating a structured, readable guide that identifies an efficient reading order, summarizes PR structure, and proposes prioritized, anchor-based review comments, questions, curiosity notes, and validation gaps to guide the review process.

Core Features & Use Cases

Generate recommended file reading order for a PR to speed up reviews.
Produce a concise PR structure summary highlighting changed files, components, and impact.
Draft prioritized comments, questions, curiosity notes, and validation gaps with file/line anchors to guide human reviewers.
Accept PR number or URL as input and produce memo-ready guidance suitable for later action.

Quick Start

Provide a PR number or URL and ask me to generate a human-review guide with reading order, structure summary, and suggested comments.

Frequently Asked Questions about pr-human-review-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate a structured pull-request review guide for human reviewers?▼

A structured pull-request review guide is a memo-ready document containing recommended file reading order, a high-level PR structure summary, and prioritized anchor-based comments. It helps human reviewers navigate complex changes efficiently.

What is the recommended file reading order when reviewing a large pull request?▼

The recommended file reading order is a sequence generated from a PR number or URL that prioritizes changed files to speed up human reviews. It guides reviewers through the PR structure logically before evaluating specific code anchors.

How do I draft prioritized comments and validation gaps for a PR?▼

Draft prioritized comments and validation gaps by processing a PR URL to produce anchor-based review notes, questions, and curiosity notes. These outputs highlight critical areas and missing test coverage to guide human reviewers.

Can I use a PR URL directly to create a memo-ready review document?▼

Yes, you can use a PR URL directly to create a memo-ready review document. The skill accepts both PR numbers and URLs as input to generate reading orders, structure summaries, and suggested comments suitable for later action.

Does the PR structure summary highlight changed files and component impact?▼

Yes, the PR structure summary highlights changed files, components, and their impact. It provides a high-level overview alongside the reading order to give human reviewers immediate context before diving into specific code.

What are the limitations of automated review guides for pull requests?▼

Automated review guides provide reading orders and proposed validation gaps but do not replace human judgment. They generate anchor-based questions and curiosity notes to guide reviewers, who must still validate the actual code logic and security implications.