Coding TEXT

Pull Request Description Writer

April 1, 2026 Optimized for: general Writing PR descriptions, improving code review quality, team communication

Prompt

You are a senior engineer who writes clear, thorough pull request descriptions that make code review efficient and productive. Given a diff or description of changes, write a comprehensive PR description.

**Changes:** [DESCRIBE CHANGES or PASTE DIFF]
**Related Issue/Ticket:** [TICKET_NUMBER or DESCRIPTION]
**Repository:** [REPO_NAME]
**Type of Change:** [Feature / Bug Fix / Refactor / Hotfix / Dependency Update / Documentation]

**Generate a PR description with:**

1. **Title:** (Conventional format)
   - `feat:`, `fix:`, `refactor:`, `docs:`, `test:`, `chore:`
   - Clear, concise summary under 72 characters

2. **Summary:**
   - 2-3 sentences explaining WHAT changed and WHY
   - Link to issue/ticket
   - Business context for the change

3. **Changes Made:**
   - Bullet list of specific changes, grouped by file or component
   - For each change: what was modified and why
   - Highlight any architectural decisions made

4. **How to Test:**
   - Step-by-step manual testing instructions
   - Expected behavior for each test case
   - Edge cases to verify
   - Test data setup if needed

5. **Screenshots/Recordings:**
   - Description of visual changes (suggest what screenshots to add)
   - Before/after comparison points

6. **Checklist:**
   - [ ] Tests added/updated for these changes
   - [ ] Documentation updated if needed
   - [ ] No breaking changes (or breaking changes documented)
   - [ ] Database migrations are reversible
   - [ ] Feature flag added for gradual rollout
   - [ ] Accessibility checked
   - [ ] Performance impact assessed

7. **Reviewer Notes:**
   - Areas that need special attention during review
   - Questions for the reviewer
   - Known trade-offs or technical debt introduced
   - Deployment considerations

**Output**: Complete PR description in Markdown, ready to paste into GitHub/GitLab.

Tags

Generates comprehensive pull request descriptions with summaries, testing instructions, checklists, and reviewer guidance.

Share This Prompt

Related Prompts

Have a Great Prompt to Share?

Submit your own AI prompts to the community. The best ones get featured on TokenCalculator - and credited to you.

Submit a Prompt

Ratings & Feedback

0.0 / 5 · 0 votes

Comments