pr-draft-summary

Generate a PR summary, branch suggestion, title, and draft description from git context.

Updated Dec 6, 2016
One-click install
npx skills add https://github.com/majunbao/learn --skill pr-draft-summary-majunbao
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-draft-summary
Source: https://github.com/majunbao/learn/tree/main/openai-agents-python_tags/openai-agents-python-0.14.6/.agents/skills/pr-draft-summary
Command: npx skills add https://github.com/majunbao/learn --skill pr-draft-summary-majunbao

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill generates a complete PR draft, including a ready-to-submit summary, a branch suggestion, a descriptive title, and a draft description for changes that affect runtime code, tests, examples, build/test configuration, or documentation.

Core Features & Use Cases

  • Generates a concise PR summary and a PR-ready title and draft description after substantive repository changes.
  • Suggests an appropriate branch name and pairs it with an auto-generated description suitable for code reviewers.
  • Automatically collects context such as the current branch, working tree status, untracked files, changed files, and the latest release tag to ensure accurate handoff notes.

Quick Start

Invoke pr-draft-summary after completing substantive changes to automatically generate a PR draft block for review.

Frequently Asked Questions about pr-draft-summary

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

FAQPage Schema
How do I automatically generate a pull request draft from git status?

Generating a pull request draft automatically involves analyzing your current branch, working tree status, untracked files, and changed files. It computes this git context to produce a ready-to-paste PR summary, title, and description block.

What is the best way to create a PR-ready summary for code review?

Creating a PR-ready summary requires compiling substantive repository changes into a concise handoff. It collects context like the latest release tag and changed files to output a descriptive title and draft description for reviewers.

Can I suggest a branch name automatically based on untracked files?

Yes, suggesting a branch name automatically is possible by evaluating your working tree status and untracked files. It uses this context to generate an appropriate branch suggestion paired with an auto-generated PR description.

Does generating a PR draft work for changes to tests and build configuration?

Generating a PR draft works for changes affecting runtime code, tests, examples, build configuration, or documentation. It processes these substantive repository changes to ensure accurate handoff notes for merging.

How do I compile release tag context into a pull request description?

Compiling release tag context into a pull request description involves fetching the latest release tag alongside your current branch status. It uses this metadata to ensure the generated draft accurately reflects repository changes.