skills.rest
huGgW
huGgWCOMMUNITY
Explore all skills by this author →
GitHub

pr-description

Generate a README.md file from a Jupyter notebook's metadata and content.

1|Updated Mar 27, 2022
Search Tags:#automation#git#template#diff#pr#description
One-click install
npx skills add https://github.com/huGgW/dotfiles --skill pr-description-huggw
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/huGgW/dotfiles/tree/main/agent_rules/skill/pr-description
Command: npx skills add https://github.com/huGgW/dotfiles --skill pr-description-huggw

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This rule helps automate PR description creation by consolidating changes between branches, file diffs, and relevant conversation context, while referencing the project's PR template for structure.

Core Features & Use Cases

  • Analyze git diffs between the current branch and a specified base branch to surface changed files, commit summaries, and key changes.
  • Read .github/PULL_REQUEST_TEMPLATE.md and synthesize content that aligns with project standards.
  • Produce a ready-to-submit PR description that can be reviewed and adjusted before merging.

Quick Start

Ask the AI to generate a PR description with context and specify the branch to compare against.

Frequently Asked Questions about pr-description

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

FAQPage Schema
How do I generate a PR description from a git diff automatically?▼

To generate a PR description from a git diff, this Skill analyzes changed files and commit summaries between your current branch and a specified comparison branch, then structures the output using your project's PR template.

Does this tool read the PULL_REQUEST_TEMPLATE.md file when creating descriptions?▼

Yes, this tool reads the .github/PULL_REQUEST_TEMPLATE.md file directly to synthesize content that aligns with your specific project standards and formatting requirements.

Can I include conversation context when generating PR descriptions?▼

Yes, you can incorporate conversation context when generating PR descriptions, allowing the AI to synthesize branch differences and relevant discussions into a comprehensive, ready-to-submit summary.

How do I create a PR description that highlights code changes for review?▼

You can create a PR description highlighting code changes by asking the AI to compare your current branch against a base branch; it extracts file diffs and commit summaries to produce a review-ready output.

What is the best way to automate PR description creation for multiple commits?▼

Automating PR description creation for multiple commits involves analyzing the git diff history between branches to extract commit summaries, which are then consolidated into a structured, ready-to-submit description.

Do I need a specific base branch to extract changed files for a PR?▼

No specific default base branch is required, but you must specify a comparison branch so the tool can accurately extract changed files and analyze the differences to generate the final PR description.

Related Skills

Explore More Software Engineering Skills→
SeventeenthEarthSeventeenthEarth

17th-pr-summary

Generate standardized PR titles and summaries from git diffs and commit history.

Community
Basic
Jia-Hong-PengJia-Hong-Peng

land-and-deploy

Merges pull requests and verifies production canary health after CI/CD deployment completes.

Community
Advanced
Gaku52Gaku52
6

git-workflow

Establish and enforce Git workflows with branching, commit, and PR conventions.

Community
Advanced
propstreetpropstreet
2

update-pr

Generate structured Markdown PR summaries from branch changes and update via gh CLI.

Official
Advanced