Pull Request Description Prompt
Turn a verified diff, ticket, test evidence, risks, and rollout notes into a concise pull request description without inventing behavior or completed checks.
Prompt Template
You are a senior software engineer writing an accurate pull request description from repository evidence I supply. Separate verified facts from assumptions, and never claim a test, review, migration, screenshot, benchmark, or deployment happened unless the evidence says it did. Repository and component context: [details] Target and source branches: [names] Issue, ticket, or requirement text: [paste or none] Reason for the change: [verified user or engineering problem] Commit list: [paste] Diff stat and changed-file list: [paste] Relevant diff or patch: [paste with secrets and personal data removed] Behavior before the change: [verified details] Behavior after the change: [verified details] User-visible changes: [details or none] API, schema, configuration, dependency, or environment changes: [details or none] Migration and backward-compatibility notes: [details or unknown] Tests actually run and exact outcomes: [commands and results] Checks not run: [list] Screenshots or recordings available: [links or none] Performance or accessibility evidence: [details or none] Known risks, edge cases, and follow-up work: [list] Rollout, flag, monitoring, and rollback plan: [verified details or not applicable] Reviewer focus areas: [list] Repository PR template or required headings: [paste] Sensitive details to redact: [secrets, personal data, internal URLs, customer data] Desired length and tone: [concise, detailed, maintainer-friendly] Provide: 1. A fact inventory separating verified changes, supplied intent, unresolved questions, and unsupported claims to omit. 2. One ready-to-paste Markdown pull request description using the repository's required headings. 3. A concise summary focused on behavior and reason, not a file-by-file transcript. 4. A change list grouped by user behavior, implementation, data or API contract, and operations only where supported. 5. A testing section that quotes exact commands and outcomes, with unchecked items clearly marked not run. 6. Risk, compatibility, migration, rollout, and rollback sections only when relevant evidence exists. 7. A reviewer guide naming the highest-risk files, decisions, or flows and why they need attention. 8. Links or references only when supplied; use placeholders for missing issue or screenshot URLs. 9. A shorter alternative for a small change. 10. A final audit for invented behavior, overstated test coverage, hidden breaking changes, secret leakage, stale template checkboxes, and noisy implementation detail. Do not invent a ticket, user impact, benchmark, screenshot, test result, approval, deployment status, or security conclusion. If the diff and stated intent conflict, call out the mismatch before drafting the description.
Example Output
Summary
- Adds server-side validation before profile changes are saved.
- Returns field-level errors without clearing valid form input.
Why
The supplied issue and diff show that invalid values previously reached the persistence layer and produced a generic failure response.
Changes
- Reuses the existing validation rules in the update handler.
- Maps verified validation failures to the existing field-error response shape.
- Adds focused tests for accepted values and two supplied invalid cases.
Testing
- Verified: `[test command]` completed successfully according to the supplied output.
- Not run: full end-to-end suite.
Risk and Review Focus
Review error mapping and confirm that the response contract remains backward compatible. No deployment or production verification is claimed.
Screenshots
Not applicable; no visual change was supplied.
Tips for Best Results
- 💡Paste the diff stat, relevant patch, and exact test output so the description can distinguish evidence from intent.
- 💡Include the repository's pull request template to preserve required headings and checklists.
- 💡List checks that were not run; never let the model infer green tests from code changes.
Frequently Asked Questions
What is the Pull Request Description Prompt prompt?
Turn a verified diff, ticket, test evidence, risks, and rollout notes into a concise pull request description without inventing behavior or completed checks. It's a free ChatGPT prompt template from our Coding collection — copy it, fill in the bracketed variables, and paste it into your AI tool.
Which AI tools work with this prompt?
It's written and tested for ChatGPT, Claude and Gemini. Any AI assistant that accepts free-form text prompts will handle it well.
How do I customize this ChatGPT prompt?
Replace the bracketed variables — such as [details], [names], [paste or none] — with your own details before running it. Paste the diff stat, relevant patch, and exact test output so the description can distinguish evidence from intent.
Is this prompt free to use?
Yes. Every prompt on PromptAtlas is free to copy, customize, and use — no signup required.
Related Prompts
Code Review Assistant
Get a thorough, senior-level code review with actionable feedback on quality, security, performance, and best practices.
Debugging Detective
Systematically debug errors and unexpected behavior with root cause analysis and fix suggestions.
Code Refactoring Advisor
Transform messy, complex code into clean, maintainable, well-structured code with clear explanations.