skills.rest
BSteffaniak
BSteffaniakCOMMUNITY
Explore all skills by this author →
GitHub

pr-description

Generate markdown PR titles and descriptions from branch commits and diffs.

Updated Dec 24, 2024
Search Tags:#automation#git#developer tools#code review#pull request
One-click install
npx skills add https://github.com/BSteffaniak/nix-config --skill pr-description-bsteffaniak
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-description
Source: https://github.com/BSteffaniak/nix-config/tree/main/configs/opencode/skills/pr-description
Command: npx skills add https://github.com/BSteffaniak/nix-config --skill pr-description-bsteffaniak

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

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

Core Features & Use Cases

  • Automated PR Content Generation: Creates markdown-formatted PR titles and descriptions based on code changes.
  • Read-only Output: Generates content for the user to copy, without modifying any files.
  • Use Case: After completing a feature, run this Skill to get a well-formatted PR description ready to be pasted into your code review platform.

Quick Start

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

Frequently Asked Questions about pr-description

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

FAQPage Schema
How do I generate a PR description from git commits and diffs?▼

To generate a PR description from git commits, this Skill analyzes branch-specific commits and diffs to automatically produce a markdown-formatted title and description for code reviews.

Can I automatically create a pull request title from branch-only commits?▼

Yes, you can automatically create a pull request title from branch-only commits. The Skill analyzes the diffs and commits unique to your branch to generate a consistent, markdown-formatted title and description.

What is the best way to automate pull request content generation for code review?▼

The best way to automate pull request content generation is using a read-only Skill that analyzes your branch diffs and outputs markdown text. It adheres to specific PR description formats to ensure quality and consistency for code reviews.

Does generating a PR description modify my repository files or branches?▼

Generating a PR description does not modify your repository files. The Skill operates as a read-only tool that outputs text for manual copying, ensuring your branch commits and diffs remain untouched.

Do I need to manually format the output when automating PR descriptions?▼

You do not need to manually format the output. The Skill automatically generates the PR title and description in markdown format based on the analysis of your branch-only commits and diffs, ready for manual copying.

Related Skills

Explore More Software Engineering Skills→
senior-sigansenior-sigan

pr-describe

Analyze Git branch changes to generate Conventional Commits PR titles and descriptions.

Community
Intermediate
notorious-ainotorious-ai
5

Writing Pull Requests

Generate GitHub Pull Request titles and descriptions with imperative verbs and motivation-driven context.

Official
Intermediate
leafcoderleafcoder
2

git-workflow

Standardize Git practices and collaboration workflows across GitHub and Gitee.

Community
Intermediate
jhd3197jhd3197
18

create-pr

Generate pull request titles and descriptions from branch commits and diffs.

Community
Intermediate