pr-draft-summary

Generate a one-line commit message and Markdown PR description from staged changes and branch commits.

13.6k|2.7k|Updated Nov 6, 2009
One-click install
npx skills add https://github.com/redis/redis-py --skill pr-draft-summary-redis
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-draft-summary
Source: https://github.com/redis/redis-py/tree/main/.agents/skills/pr-draft-summary
Command: npx skills add https://github.com/redis/redis-py --skill pr-draft-summary-redis

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing a clear commit message and a well-structured pull request description for redis-py changes is repetitive and easy to get wrong, especially when the work spans staged changes, branch commits, and sync/async code paths. This Skill inspects the actual git diffs and produces both artifacts automatically. ## Core Features & Use Cases - Commit message generation: Produces a single-line imperative commit message with a conventional prefix (feat, fix, refactor, perf, docs, test, build, chore) inferred from the touched paths. - PR description drafting: Emits a copy-pasteable Markdown block with Change summary and Test coverage sections, kept to 5–6 short paragraphs. - Scope and risk analysis: Covers staged changes plus branch commits relative to the PR base by default, flags backward-compatibility risk on public API changes, and calls out missing sync/async parity between redis/ and redis/asyncio/. - Use Case: After finishing a bug fix on a feature branch, ask for a PR draft and receive a commit message plus a ready-to-paste GitHub PR description that references the resolved issue automatically. ## Quick Start Ask the assistant to generate a commit message and PR description for the staged changes on the current branch.

Frequently Asked Questions about pr-draft-summary

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

FAQPage Schema
How do I generate a PR description from my git changes?▼

Ask for a PR draft after staging your work. The Skill runs git status, git diff --stat --cached, and branch commit logs against the PR base, then outputs a commit message and a Markdown PR description with Change summary and Test coverage sections.

How to write a conventional commit message automatically?▼

The Skill infers the change type from touched paths, such as redis/ for runtime code or tests/ for test changes, and picks the matching prefix like feat, fix, refactor, or perf. It then drafts a single-line imperative commit message.

Does it include unstaged or untracked files in the PR summary?▼

No, by default it covers only staged changes and commits already on the current branch. Unstaged and untracked files are included only when you explicitly ask, with untracked files picked up from git status -sb.

Can I set a custom base branch for the PR diff?▼

Yes, you can name any base branch, including feature or integration branches. If none is given, it defaults to origin/master with a fallback to master, then computes the merge base for the diff range.

What are the limitations of automated PR description generation?▼

The output depends on the quality of the actual diffs and commit messages, and it skips generation entirely when no in-scope changes exist. It also cannot fetch issue details, so issue references rely on branch naming conventions like issue-<number>.