skills.rest
johnend
johnendCOMMUNITY
Explore all skills by this author →
GitHub

describe-pr

Generate or refresh PR descriptions using templates and JIRA ticket extraction.

23|3|Updated May 17, 2024
Search Tags:#templates#jira#pr#description#pull-request#gh-cli#branch-name
One-click install
npx skills add https://github.com/johnend/dots --skill describe-pr-johnend
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: describe-pr
Source: https://github.com/johnend/dots/tree/main/common/.ai/skills/describe-pr
Command: npx skills add https://github.com/johnend/dots --skill describe-pr-johnend

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generate or refresh PR descriptions to enforce a clear, consistent, template-driven structure across projects.

Core Features & Use Cases

  • Extracts JIRA ticket IDs from the current branch name and attaches them to the PR body.
  • Applies repository PR templates to ensure required sections (Changes, Why, Testing, Evidence).
  • Supports updating existing PR descriptions while preserving user-added notes.

Quick Start

Run describe-pr to generate or update the PR description for the current branch.

Frequently Asked Questions about describe-pr

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

FAQPage Schema
How do I automatically generate a pull-request description from a branch name?▼

You can generate a pull-request description automatically by running a template-driven command that analyzes your branch context and existing PR body, extracting JIRA ticket IDs to compose a compliant description with required sections.

Does gh CLI support updating existing PR descriptions while preserving user notes?▼

Yes, updating existing PR descriptions while preserving user-added notes is supported by analyzing the current PR body and refreshing the template-driven structure to ensure sections for changes, rationale, testing, and evidence remain compliant.

Can I extract a JIRA ticket ID from my git branch and add it to a PR template?▼

Yes, you can extract a JIRA ticket ID from your git branch name and attach it to the PR body by using a tool that parses branch context and applies standard PR templates to enforce a consistent structure across your project.

What is the best way to enforce a consistent PR template structure across projects?▼

The best way to enforce a consistent PR template structure is to automatically generate or refresh PR descriptions using a template-driven approach that applies required sections for changes, rationale, testing, and evidence across typical feature and bugfix workflows.

Do I need gh CLI to apply repository PR templates for bugfix workflows?▼

Yes, you need gh CLI installed to apply repository PR templates for bugfix workflows, as the tool requires it to analyze branch context, extract JIRA tickets, and compose compliant PR descriptions with sections for changes and testing.

Related Skills

Explore More Software Engineering Skills→
flurdyflurdy
6

jira-ticket

Fetch Jira ticket details and map issue types to branch prefixes.

Community
Intermediate
grichagricha

create-pr

Create GitHub pull requests with standardized titles and summaries via gh pr create.

Community
Intermediate
JaviMalignoJaviMaligno
1

commit-pr

Generate commit messages, PR titles, and branch names from an issue URL.

Community
Intermediate
paulchiupaulchiu
3

write-pull-request

Generate pull request descriptions from git diff and commit history.

Community
Intermediate