pr-description-write

Generate a Pull Request title and description from current branch commits and diffs.

Updated Dec 24, 2024
One-click install
npx skills add https://github.com/BSteffaniak/nix-config --skill pr-description-write
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-description-write
Source: https://github.com/BSteffaniak/nix-config/tree/main/configs/opencode/skills/pr-description-write
Command: npx skills add https://github.com/BSteffaniak/nix-config --skill pr-description-write

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of Pull Request titles and descriptions by analyzing branch-specific commits and diffs, streamlining the code review process.

Core Features & Use Cases

  • Automated PR Content Generation: Creates a relevant PR title and a detailed description based on code changes.
  • Branch Analysis: Focuses solely on commits and diffs within the current branch for accurate context.
  • Use Case: After completing a feature, use this Skill to quickly generate a PR description that summarizes your changes, saving you time and ensuring consistency.

Quick Start

Use the pr-description-write skill to generate a PR description for the current branch.

Frequently Asked Questions about pr-description-write

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

FAQPage Schema
How do I generate a pull request description from my git branch automatically?

To generate a pull request description automatically, this Skill analyzes the unique commits and diffs on your current Git branch. It then outputs a structured PR title and description to a temporary file for your review.

What is the best way to summarize code changes for a pull request without writing it manually?

Summarizing code changes for a pull request is done by analyzing branch-specific commits and diffs. The generated content follows a predefined format to ensure quality and consistency, saving you manual writing effort.

Can I use this to analyze commits from only my current feature branch?

Yes, you can use this to analyze commits from your current feature branch. The branch analysis focuses solely on the unique commits and diffs within your active branch to provide accurate context for the PR description.

Do I need to install any dependencies to automate PR content generation?

No dependencies are required to automate PR content generation. The Skill operates independently to analyze your Git branch and write the resulting PR title and description to a temporary file.

Where does the generated pull request title and description get saved?

The generated pull request title and description are written to a temporary file. This allows you to review the automated branch analysis output and copy the content for subsequent use in your code review process.