skills.rest
mczkzk
mczkzkCOMMUNITY
Explore all skills by this author →
GitHub

pr-template

Generates GitHub pull-request titles, descriptions, and label recommendations from a diff and plan.md file.

Updated Jul 8, 2017
Search Tags:#automation#git#developer tools#code review#pull request#github
One-click install
npx skills add https://github.com/mczkzk/dotfiles --skill pr-template-mczkzk
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-template
Source: https://github.com/mczkzk/dotfiles/tree/main/dot_claude/skills/pr-template
Command: npx skills add https://github.com/mczkzk/dotfiles --skill pr-template-mczkzk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of GitHub Pull Request titles and descriptions by analyzing the code changes in a given PR, ensuring consistency and saving developers time.

Core Features & Use Cases

  • Automated PR Summarization: Generates a concise title and detailed description based on the PR's diff.
  • Label Recommendation: Suggests relevant labels for the PR based on its content.
  • Plan Integration: Incorporates information from a "plan.md" document for richer context.
  • Use Case: When you push a new feature branch, this Skill can draft a PR title like "Feat: Implement user authentication flow" and a description detailing the changes and how to test them, referencing any related design documents.

Quick Start

Use the pr-template skill to generate a PR title and description for PR number 123.

Frequently Asked Questions about pr-template

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

FAQPage Schema
How do I automatically generate a GitHub pull request title and description from a diff?▼

You can automatically generate a GitHub pull request title and description by analyzing the PR diff. This Skill parses the code changes and associated plan documents to draft a concise title and detailed description, ensuring consistency and saving time.

Can I recommend relevant labels for a pull request based on its content?▼

Yes, you can recommend relevant labels for a pull request based on its content. The Skill fetches repository labels and analyzes the diff to suggest accurate labels, ensuring the PR is properly categorized for code review.

Does the PR generator work with existing plan documents for richer context?▼

Yes, the PR generator works with existing plan documents for richer context. It incorporates information from a plan.md file alongside the diff to create a more comprehensive pull request description detailing changes and testing instructions.

What's the best way to avoid data loss when updating an existing GitHub pull request?▼

The best way to avoid data loss when updating an existing GitHub pull request is to merge remote changes before pushing updates. The Skill ensures user confirmation before updating PRs and automatically merges remote changes to prevent conflicts.

Why does the pull request generator need to auto-detect the PR number from the current branch?▼

The pull request generator auto-detects the PR number from the current branch to streamline the automation workflow. This allows the Skill to fetch the correct diff, repository labels, and existing PR data without manual input.

When should I not use an automated tool to draft my pull request?▼

You should not use an automated tool to draft your pull request when your changes require nuanced human explanation or do not have an associated plan.md document. The Skill relies on diff analysis and plan integration for accurate summarization.

Related Skills

Explore More Software Engineering Skills→
jedmamostojedmamosto

gsd-pr-branch

Filter .planning/ commits to create a clean PR-ready branch.

Community
Basic
Elevaria-biaElevaria-bia

aiox-devops

Run automated quality gates and control GitHub push, PR, and release operations.

Community
Advanced
dzineerdzineer

update-2-git-with-diff

Generate a Git diff, create a pull request, and merge into the main branch.

Community
Intermediate
cenk1cenk2cenk1cenk2
2

github-pr

Analyze branch commits and diffs to draft GitHub pull request titles and descriptions.

Community
Intermediate