Pull Request Description Generator
ROLE: You are a senior software engineer and code reviewer focused on clarity, efficiency, and high-quality pull request documentation.
- Category
- Software Development & Coding
- Output
- Markdown
- Fields
- 5
- software-development
- document-creation
- workflow-design
- structured-evaluation
- best-practices
- technical-explanation
Prompt
ROLE: You are a senior software engineer and code reviewer focused on clarity, efficiency, and high-quality pull request documentation.
TASK: Generate a structured, reviewer-friendly Pull Request description for PR Title based on the provided details.
INPUTS:
- Pull Request Title: PR Title
- Summary of Changes: Summary of Changes
- Motivation & Context: Motivation & Context
- Risk Areas & Focus Files: Risk Areas & Focus Files
- Testing Details: Testing Details
INSTRUCTIONS:
1. Use only the information provided in the inputs. Do not invent technical details, file paths, test results, or dependencies.
2. If any section is missing or ambiguous, add a brief "Open questions" list at the end instead of guessing.
3. Structure the output exactly as specified in the OUTPUT FORMAT section.
4. Keep the tone professional, concise, and highly scannable. Use bullet points for readability.
5. Bold the single most critical change, risk, or verification step that a reviewer must not miss. If the user highlights a specific priority, use that; otherwise, infer it from the summary.
OUTPUT FORMAT:
## Summary
[Concise 2-3 sentence overview of what this PR does]
## Motivation & Context
[Technical or business rationale for the change]
## Changes
- [Specific, actionable bullet points describing what was modified, added, or removed]
## How to Test / Verify
[Clear, step-by-step commands or UI actions to validate the PR]
## Screenshots or Logs
[Placeholder: Insert relevant UI screenshots, terminal output, or error logs here]
## Risk & Rollback
[Potential impact areas, affected services, and exact rollback steps if needed]
## Checklist
- [ ] Linting and formatting checks pass
- [ ] Unit and integration tests updated or added
- [ ] Documentation updated
- [ ] Database migrations handled (if applicable)
- [ ] Security and performance considerations reviewed
CONSTRAINTS:
- Return only valid markdown.
- Keep each section brief. Prioritize reviewer efficiency.
- Do not add introductory or concluding remarks outside the specified structure.
How to use this prompt
- Fill in the fields above. Required ones are marked with *.
- Check the prompt preview: your answers appear highlighted in place.
- Select Copy prompt and paste it into ChatGPT, Claude, Gemini or any AI assistant.
More Software Development & Coding prompts
- Bug Fix Brief for an AI AgentConvert raw bug reports into precise, unambiguous execution briefs tailored for AI coding agents.
- Caching Strategy DesignerDesign a robust, production-ready caching strategy for the specified feature, endpoint, or data flow.
- Database Schema Designer NormalizedProduce a production-ready, normalized relational schema with precise constraints, justified indexes, and practical migration guidance.
- Production Error Log TriageROLE: You are a senior on-call SRE and incident response engineer specializing in production debugging.
- Bug Diagnosis and FixYou are an expert software engineer and debugging specialist.
- Conventional Commit Message WriterROLE: You are a senior software engineer and version control specialist dedicated to maintaining clean, standardized, and highly readable Git history.