skills.rest
weval-org
weval-orgOFFICIAL
Explore all skills by this author →
WebsiteGitHub

pr-describe

Generate structured GitHub pull request descriptions from branch diffs.

31|9|Updated May 31, 2025
Search Tags:#code review#pull request#screenshots#conventional commits#github#pr description#branch diff
One-click install
npx skills add https://github.com/weval-org/app --skill pr-describe-weval-org
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-describe
Source: https://github.com/weval-org/app/tree/main/.claude/skills/pr-describe
Command: npx skills add https://github.com/weval-org/app --skill pr-describe-weval-org

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill turns a branch diff into a clear, review-ready pull request description so engineers can communicate changes without manually drafting the summary, context, tests, and risks.

Core Features & Use Cases

  • Produces a conventional-commits PR title and a structured body with summary, motivation, changes, test plan, risks, and related issues.
  • Summarizes diffs across UI, API, CLI, docs, and tests, making it useful for routine code changes and release preparation.
  • Optionally adds before/after screenshots for static visual changes while respecting safety guardrails for public repositories.

Quick Start

Ask the pr-describe skill to generate a ready-to-paste pull request description from the current branch diff.

Frequently Asked Questions about pr-describe

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

FAQPage Schema
How do I generate a pull request description from a branch diff?▼

Generating a pull request description from a branch diff involves analyzing code changes to produce a structured summary with motivation, test plans, and risk assessments. This automates drafting PR documentation directly from your Git history.

What is a conventional commits PR title and how is it inferred from code changes?▼

A conventional commits PR title follows a standardized format like feat or fix, inferred by analyzing the semantic meaning of your branch diff. This categorizes modifications automatically, ensuring consistent commit history across software engineering workflows.

Can I automatically add before and after screenshots to my GitHub PR description?▼

Yes, you can automatically add before and after screenshots to a GitHub PR description for static visual UI updates. The process respects safety guardrails specifically for public repositories to prevent unauthorized image uploads.

Does this PR generation approach work for different types of code changes like tests and docs?▼

Yes, this PR generation approach works for different types of code changes including UI, API, CLI, docs, and tests. It summarizes diffs across these varied formats, making it useful for routine engineering work and release preparation.

What should a structured pull request body include for effective code review?▼

A structured pull request body for effective code review should include a summary, motivation, detailed changes, test plan, risk assessment, and related issue links. This ensures reviewers understand the context and impact of the branch diff.

Are there limitations when generating PR descriptions for public repositories?▼

Limitations when generating PR descriptions for public repositories include safety guardrails that restrict automatic screenshot handling for visual UI updates. This prevents potential security risks associated with uploading images to public repos.

Related Skills

Explore More Software Engineering Skills→
btabaskabtabaska
1

Diff Summary

Convert a raw git diff into a structured Markdown PR description.

Community
Intermediate
sameer-thakkarsameer-thakkar

create-pr

Create GitHub Pull Requests with summaries and test plans from commit context.

Community
Advanced
liumeixinliumeixin
4

requesting-code-review

Automate code review with static analysis and an independent reviewer subagent.

Community
Advanced
camilooscargbaptistacamilooscargbaptista
7

pr-description

Generate What/Why/How summaries for GitHub or GitLab PRs with risk assessments.

Community
Advanced