Overview

This skill generates a comprehensive Markdown PR description based on the changes in the current branch. It formats content into clear sections (Summary, Changes Made, Testing, Related Issues, and Additional Notes) for GitHub PR descriptions, saving time and improving clarity.

How This Skill Works

The tool analyzes the branch changes, compiles a concise Summary, enumerates key Changes Made (code and non-code), and adds Testing notes and Related Issues. The output is formatted as proper Markdown ready to paste into a GitHub PR.

When to Use It

• When preparing a PR for a feature or bugfix branch
• When multiple files across modules are changed
• When you need to document tests and new test cases
• When linking related issues or tickets with closing keywords
• When including deployment considerations or follow-up work

Quick Start

1. Step 1: Run the PR description generator against the current branch
2. Step 2: Review the generated Markdown for accuracy and completeness
3. Step 3: Copy-paste into the GitHub PR description and adjust as needed

Best Practices

• Provide a concise, end-to-end Summary of the PR
• List all key changes under Changes Made (code and non-code)
• Highlight breaking changes and backward-compatibility notes
• Describe testing approach and results, including new tests
• Format the output as clean Markdown ready for GitHub

Example Use Cases

• PR that adds OAuth login flow with unit tests
• PR that refactors data model and updates API tests
• PR that fixes a bug and adds regression tests
• PR that introduces a breaking API change with migration notes
• PR that adds deployment-related notes for a new feature

Frequently Asked Questions