create-pr-description

Generate PR titles, descriptions, and reviewer suggestions from commits and diffs.

129|7|Updated Oct 10, 2023
One-click install
npx skills add https://github.com/zetaalphavector/RAGElo --skill create-pr-description-zetaalphavector
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-pr-description
Source: https://github.com/zetaalphavector/RAGElo/tree/main/.agents/skills/create-pr-description
Command: npx skills add https://github.com/zetaalphavector/RAGElo --skill create-pr-description-zetaalphavector

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates comprehensive PR descriptions by analyzing commits, code changes, and gathering context from issues. Use when asked to write, generate, or create a PR description, or when preparing a pull request for review.

Core Features & Use Cases

  • Analyze commits and diffs to produce a clear summary of changes.
  • Gather issue context and references to justify decisions and rationale in the PR description.
  • Propose 1-2 reviewers based on git history and project conventions to streamline reviews.

Quick Start

Provide a PR context (branch or range) and let the skill generate a title, description, and reviewer suggestions.

Frequently Asked Questions about create-pr-description

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

FAQPage Schema
How do I generate a PR description from commits automatically?

To generate a PR description from commits, provide a branch or commit range context. The skill analyzes code diffs and issue references to produce a concise title, full description, and suggested reviewers.

Can I use git history to suggest reviewers for a pull request?

Yes, you can suggest reviewers for a pull request based on git history. The skill analyzes project conventions and past commit activity to propose 1-2 relevant reviewers for the code review.

How do I write a pull request summary that includes issue context?

To write a pull request summary with issue context, the skill gathers referenced issue details and analyzes code diffs. It uses this information to justify decisions and document the rationale directly in the PR description.

What is the best way to create a complete PR description for review?

The best way to create a complete PR description for review is to analyze commits and code changes. The skill compiles these diffs with issue references to craft a structured title and detailed summary.

Do I need to provide issue references to generate a pull request description?

While you can generate a pull request description from just commits and diffs, providing issue references enhances the output. The skill uses this context to justify decisions and explain the rationale behind code changes.