PR Draft — Pull Request Description Generator

Generate structured, ready-to-paste PR descriptions from the current git branch.

When to Use

• About to open a PR and need a good description
• Want consistent PR format across the team
• Need to summarize complex changes quickly

Workflow

1. Gather context

git branch --show-current
git status
git diff --stat main..HEAD     # or the target branch
git log --oneline main..HEAD

2. Generate the PR description

Follow Conventional Commits format:

• feat: — New feature
• fix: — Bug fix
• refactor: — Code restructure
• docs: — Documentation only
• test: — Test additions/changes
• chore: — Maintenance, deps, CI

3. PR Template

## Summary
[One-sentence description of what this PR does]

## Type
- [ ] feat / fix / refactor / docs / test / chore

## Changes
- [Bullet list of specific changes]

## Testing
- [ ] Tests pass (`pytest` / `npm test`)
- [ ] Manual verification: [describe what you tested]

## Screenshots
[If UI changes, include before/after]

## Notes
[Anything reviewers should know]

Tips

• Use git diff --stat for the overview, git diff for details
• Group changes by area (frontend, backend, infra)
• Mention breaking changes prominently
• Link related issues with Fixes #123 or Closes #456

Pitfalls

• git diff main..HEAD may be wrong if main has diverged — use git merge-base main HEAD to find the true fork point
• Empty diff output usually means you're already on main or the branch name is wrong
• Avoid referencing tickets or usernames that don't exist — reviewers will be confused

Verification

# Confirm you're on the right branch with changes
git branch --show-current && git log --oneline main..HEAD
# Preview the diff stat before drafting
git diff --stat $(git merge-base main HEAD)..HEAD