pr-draft-summary

Generate pull request titles and draft descriptions from Git commit history.

6|2|Updated Aug 22, 2024
One-click install
npx skills add https://github.com/NQ-lovecpp/cpp_chatsystem --skill pr-draft-summary-nq-lovecpp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-draft-summary
Source: https://github.com/NQ-lovecpp/cpp_chatsystem/tree/main/ChatSystem-Backend/8.Agent_Server/examples/openai-agents-python-main/.agents/skills/pr-draft-summary
Command: npx skills add https://github.com/NQ-lovecpp/cpp_chatsystem --skill pr-draft-summary-nq-lovecpp

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the creation of a Pull Request summary block, including a title and draft description, for substantive code changes, streamlining the code review process.

Core Features & Use Cases

  • Automated PR Summary: Generates a PR-ready summary block with change summaries, titles, and descriptions.
  • Change Classification: Infers change type (feature, fix, refactor, docs) and flags backward-compatibility risks.
  • Use Case: After completing a set of code changes for a new feature, trigger this Skill to get a perfectly formatted PR summary ready to paste into your pull request.

Quick Start

Use the pr-draft-summary skill to generate a PR summary for your current changes.

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 title and description from git commits?

You can generate a pull request title and description by analyzing your git repository status and commit history. The tool inspects staged, unstaged, and untracked files, alongside commits ahead of the base fork point, to infer change type and summarize modifications for your PR.

What is the best way to draft a GitHub pull request summary for code review?

The best way to draft a GitHub pull request summary is to automate change classification based on commit history. This process infers whether your updates are a feature, fix, refactor, or docs change, and flags backward-compatibility risks to streamline code review.

Can I link GitHub issues and suggest branch names automatically when creating a PR draft?

Yes, you can link GitHub issues and suggest branch names automatically when creating a PR draft. The workflow integration analyzes your repository status and commits to support automated branch naming suggestions and issue linking for enhanced context.

Does this PR summary tool work with untracked and unstaged files in my git repository?

Yes, this PR summary tool works with untracked and unstaged files in your git repository. It analyzes all staged, unstaged, and untracked files along with your commit history to accurately infer the change type and summarize modifications.

How does change classification work for automated pull request descriptions?

Change classification for automated pull request descriptions works by analyzing your commits and repository status. It evaluates the modifications to infer the change type—such as feature, fix, refactor, or docs—and flags any potential backward-compatibility risks.

When should I use an automated PR draft summary instead of writing it manually?

You should use an automated PR draft summary instead of writing manually when you need to streamline the code review process for substantive code changes. It generates a perfectly formatted PR summary block by analyzing your commit history and repository status instantly.