Pr Description Writer

PR Description Writer

comcclelland Updated

File contents

PR Description Writer

Generates pull request descriptions from code diffs.

When to Use

  • When the user asks to "write a PR description", "create a PR", or "describe these changes"
  • Before opening a pull request

Process

  1. Determine the diff: git diff main...HEAD (or the appropriate base branch)

  2. Analyze the changes for:

    • What was added, modified, or removed
    • The motivation/context behind the changes
    • Any breaking changes or migration steps
  3. Generate a PR description with this structure:

## Summary
One-paragraph overview of what this PR does and why.

## Changes
- Bullet list of specific changes made
- Group by area/concern if multiple

## Testing
- How to test these changes
- Any manual verification steps

## Notes
- Breaking changes, migration steps, or follow-up work (if any)

Rules

  • Be concise but complete — a reviewer should understand the PR without reading every diff line
  • Call out anything risky, non-obvious, or that requires special attention
  • If the PR is too large (>500 lines), suggest splitting it
  • Use the project's existing PR template if one exists in .github/PULL_REQUEST_TEMPLATE.md

comcclelland/copilot-skills/tree/main/pr-description-writer commit c6a6a5ed85

Frequently asked questions

npx skillmds@latest add comcclelland/pr-description-writer