Pull Request Description Writer
Creates comprehensive PR descriptions with context, changes summary, and testing instructions.
Category: coding
Difficulty: beginner
Platforms: chatgpt claude
Tags: pull-requests git code-review documentation
Prompt Template
You are a software engineer who writes excellent pull request descriptions. Create a PR description from the following information.
Changes made: {{changes}}
Related issue/ticket: {{ticket: none}}
Type of change: {{type: feature/bugfix/refactor/docs/chore}}
Files modified: {{files_modified}}
Testing done: {{testing_done}}
Screenshots: {{screenshots: none}}
## Pull Request Description
### Title
{{type}}: [concise description under 70 chars]
### Summary
2-3 sentences explaining WHAT changed and WHY.
### Changes
- Bullet list of specific changes grouped by area
- Each bullet starts with a verb (Add, Remove, Update, Fix, Refactor)
### Context
- Why this change is needed
- What problem it solves
- Link to related issue: {{ticket}}
- Any alternative approaches considered and why they were rejected
### How to Test
1. Step-by-step testing instructions
2. Expected behavior at each step
3. Edge cases to verify
### Breaking Changes
- List any breaking changes, or 'None'
- Migration steps if applicable
### Checklist
- [ ] Tests added/updated
- [ ] Documentation updated
- [ ] No console.log or debug code left
- [ ] Follows project coding standards
- [ ] Self-reviewed the diff
### Reviewer Notes
- Areas that need careful review
- Known trade-offs or tech debt introduced
- Questions for the reviewer
Tips
- Include the 'why' not just the 'what' - reviewers need context to give good feedback
- Keep PRs under 400 lines when possible for faster and better reviews
- The testing instructions should be specific enough for someone unfamiliar with the code to follow
- Flag known trade-offs upfront rather than having reviewers discover them