pr-review-canvas

Generate an interactive HTML PR review walkthrough from a GitHub PR URL.

58|5|Updated Aug 30, 2024
One-click install
npx skills add https://github.com/StudyDrift/lextures --skill pr-review-canvas-studydrift
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-review-canvas
Source: https://github.com/StudyDrift/lextures/tree/main/.cursor/skills/pr-review-canvas
Command: npx skills add https://github.com/StudyDrift/lextures --skill pr-review-canvas-studydrift

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates an interactive PR review walkthrough as an HTML page by fetching PR data via gh API, categorizing files into core vs mechanical changes, adding reviewer annotations, and rendering diffs with moved-code detection. Use when the user pastes a GitHub PR URL and asks for a review, walkthrough, or summary, or says "review this PR".

Core Features & Use Cases

  • Fetch PR data via gh api calls for PR details, files, and comments.
  • Analyze the PR and compose an HTML body with structured sections, reviewer notes, and diff rendering that highlights moved code.
  • Render diffs with moved-code detection and provide optional callouts, diagrams, and interactive widgets to aid understanding.

Quick Start

Paste a GitHub PR URL and ask for a review, walkthrough, or summary.

Frequently Asked Questions about pr-review-canvas

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

FAQPage Schema
How do I generate a walkthrough for a GitHub PR?

To generate a PR walkthrough, you provide a GitHub PR URL and request a review. The skill fetches PR data via the gh API and renders an interactive HTML walkthrough with reviewer annotations and file categorizations.

What is interactive HTML PR review and how does it work?

Interactive HTML PR review is a formatted webpage that categorizes files into core versus mechanical changes and displays diffs with moved-code detection. It works by fetching PR data via the gh CLI and assembling it using a template renderer.

Do I need the gh CLI to review a PR as HTML?

Yes, the gh CLI is required to retrieve PR details, files, and comments from GitHub. The skill uses this data to compose the structured HTML body with diff rendering and reviewer notes.

Can I add reviewer annotations to GitHub PR diffs?

Yes, you can add reviewer annotations to GitHub PR diffs. The skill analyzes the PR data fetched via the gh API and composes an HTML body that includes structured reviewer notes and interactive callouts.

Does PR review HTML rendering detect moved code in diffs?

Yes, PR review HTML rendering includes moved-code detection within the diffs. It highlights moved code and provides optional callouts, diagrams, and interactive widgets to help you understand the changes.

What is the best way to summarize a large GitHub PR?

The best way to summarize a large GitHub PR is by generating an interactive HTML walkthrough. The skill categorizes files into core and mechanical changes, providing a structured visual summary with reviewer annotations and diff rendering.