Skill

Enhance Pull Request Descriptions

Turns a git diff into a structured, reviewer-friendly PR description with a category-driven checklist and risk notes.


91
Spark score
out of 100
Updated 22 days ago
Version 14.0.0

Add to Favorites

Why it matters

Transform raw Git diffs into structured, reviewer-friendly pull request descriptions. Automate the generation of summaries, change categorizations, risk assessments, and testing checklists to streamline code review.

Outcomes

What it gets done

01

Generate PR summaries with categorized changes (source, test, config, etc.)

02

Create detailed PR descriptions including risks and rollback plans

03

Add context-specific review checklists based on file categories

04

Identify and flag breaking changes, security risks, and large diffs

Install

Add it to your toolbox

Run in your project directory:

curl -fsSL https://spark.entire.vc/get/ag-comprehensive-review-pr-enhance | bash

Overview

Pull Request Enhancement

PR description generation skill that turns a git diff into a structured summary with a Changes table, testing notes, and Risks & Rollback section, plus a review checklist whose sections activate based on which file categories changed. Use when a git diff needs a reviewer-friendly PR description with change categories, risks, and a checklist, especially for larger diffs.

What it does

This skill turns a git diff into a reviewer-friendly pull request description, producing a PR summary with change categories, risks, testing notes, and a review checklist - for diffs large enough that reviewers need explicit structure instead of a short ad hoc summary. The workflow runs git diff <base>...HEAD --stat to identify changed files and scope, categorizes changes into source/test/config/docs/build/styles, generates the PR description from a fixed template, adds a review checklist based on which file categories actually changed, and flags breaking changes, security-sensitive files, or large diffs over 500 lines. The PR description template has four sections: a one-paragraph executive Summary of what changed and why, a Changes table listing category/files/key-change per row, a Why section linking the originating issue or ticket, and a Testing section with unit-test/manual-smoke-test/coverage-regression checkboxes, plus a Risks & Rollback section stating whether the change is breaking, how to roll it back, and a risk level with justification. Review checklist rules add a checklist section only when its matching file category appears in the diff: source changes get checks for no debug statements, functions under 50 lines, descriptive names, and error handling; test changes get checks for meaningful assertions, edge cases, no flaky tests, and the AAA pattern; config changes get checks for no hardcoded secrets, documented env vars, and backwards compatibility; docs changes get checks for accuracy, included examples, and an updated changelog; and any path containing auth, crypto, token, or password is treated as security-sensitive and gets checks for input validation, no secrets in logs, and correct authorization. When a diff exceeds 20 files or 1000 lines, the skill suggests splitting the PR by feature area using a checkout-and-cherry-pick pattern. For automated PR analysis, coverage reports, and risk scoring, it points to a companion resources/implementation-playbook.md with Python helpers.

When to use - and when NOT to

Use this skill when you need to turn a git diff into a reviewer-friendly PR description, want a summary with change categories, risks, testing notes, and a checklist, or the diff is large enough that reviewers need explicit structure instead of a short ad hoc summary. It is not meant for trivial, single-line diffs where a one-sentence PR title is sufficient.

Inputs and outputs

Input is a git diff between a base branch and HEAD. Output is a structured PR description (Summary, Changes table, Why, Testing, Risks & Rollback) plus a review checklist whose sections are conditionally included based on which file categories - source, test, config, docs, security-sensitive - actually appear in the diff.

Integrations

Built on git diff --stat for change detection and a companion Python-based implementation playbook for automated PR analysis, coverage reporting, and risk scoring.

git checkout -b feature/part-1
git cherry-pick <commits-for-part-1>

Who it's for

Developers and teams who want consistently structured, reviewer-friendly PR descriptions with category-driven checklists and explicit risk/rollback notes, especially for large diffs.

FAQ

Common questions

Discussion

Questions & comments · 0

Sign In Sign in to leave a comment.