skills.rest
crbnos
crbnosOFFICIAL
Explore all skills by this author →
Website𝕏@carbon_msGitHub

pr-explainer

Generate a self-contained HTML review aid explaining pull request changes.

2.3k|331|Updated Jun 3, 2024
Search Tags:#code review#pull request#HTML#developer tool#review guide
One-click install
npx skills add https://github.com/crbnos/carbon --skill pr-explainer-crbnos
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-explainer
Source: https://github.com/crbnos/carbon/tree/main/.ai/skills/pr-explainer
Command: npx skills add https://github.com/crbnos/carbon --skill pr-explainer-crbnos

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and assets (resource) components.

What problem does it solve?

This Skill helps developers create a self-contained HTML review aid that explains the changes in a pull request, making it easier for reviewers to understand complex changes without leaving GitHub.

Core Features & Use Cases

  • HTML Review Aid: Generates a single HTML page that outlines the problem, system context, before/after flow, code changes, verification, and reviewer takeaway.
  • Automated Creation: Automates the process of gathering information, classifying files, and filling in the template to create the review guide.
  • Use Case: When explaining a pull request to a reviewer or when producing a review page for a branch, this Skill simplifies the process by creating a comprehensive guide in one HTML file.

Quick Start

Use the pr-explainer skill to generate a review guide for the branch 'feature-branch'.

Frequently Asked Questions about pr-explainer

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

FAQPage Schema
How do I create a review guide for a complex pull request?▼

You can generate a self-contained HTML review guide by gathering pull request facts, classifying files, and filling in a structured template to explain problem context, code changes, and verification steps for reviewers.

What is the best way to explain code changes to reviewers without leaving GitHub?▼

The best way to explain code changes is generating a single HTML review aid that outlines the problem, system context, before/after flow, code changes, and reviewer takeaway in one comprehensive page.

Can I generate an HTML review page for a specific git branch?▼

Yes, you can generate an HTML review page for a specific branch by automating the process of gathering information, classifying files, and filling in the review guide template.

When do I need a structured HTML page for code review?▼

You need a structured HTML page for code review when dealing with complex pull requests that require detailed explanations to help reviewers understand system context and changes without leaving the platform.

Does the pull request review guide work as a standalone file?▼

Yes, the pull request review guide works as a self-contained single HTML file, meaning reviewers can access the complete explanation without external dependencies or separate assets.

What sections are included in a generated PR review guide?▼

A generated PR review guide includes sections for the problem, system context, before/after flow, code changes, verification, and reviewer takeaway, providing a comprehensive overview of the pull request.

Related Skills

Explore More Software Engineering Skills→
joi-fairsharejoi-fairshare
1

review

Orchestrate parallel specialist agents to review GitHub pull requests and save findings.

Community
Advanced
Morris-UTRUSTMorris-UTRUST

publish

Publish brain pages as self-contained, password-protected HTML files.

Community
Intermediate
driftinglydriftingly
1

fix-github-issue

Create a feature branch, run local tests, and submit a pull request for GitHub issues using the gh CLI.

Community
Advanced
Community-AccessCommunity-Access
387

PR Review

Automate GitHub pull request reviews and generate markdown and HTML documents.

Official
Advanced