Generate Pull Request Descriptions
Prompt for pull request descriptions - a structured summary, change type, testing, and checklist template.
Why it matters
Automate the creation of comprehensive pull request descriptions to streamline code review processes and improve team communication.
Outcomes
What it gets done
Generate a structured PR description based on provided code changes.
Categorize changes into bug fixes, new features, or breaking changes.
Assist in documenting testing procedures and related issues.
Ensure descriptions adhere to best practices for clarity and completeness.
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/vb-pr-description | bash Overview
PR Description Generator
A prompt that generates a structured pull request description - summary, changes, change-type classification, testing, screenshots, checklist, and related issues. Use it for writing the PR description itself, not for code review or commit messages.
What it does
This prompt generates a pull request description from a given set of code changes, following a structured template:
### Summary
[Brief description of what this PR does and why]
### Changes
- Change 1
- Change 2
- Change 3
### Type of Change
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Refactoring (no functional changes)
### Testing
Describe how you tested these changes:
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing performed
### Screenshots (if applicable)
[Add screenshots for UI changes]
### Checklist
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have commented my code where necessary
- [ ] I have updated documentation as needed
- [ ] My changes generate no new warnings
- [ ] Tests pass locally
### Related Issues
Closes #[issue number]
Guidelines direct the description to be concise but comprehensive, to focus on the "why" behind the change and not just the "what," to include context for reviewers, to link related issues and documentation, and to add screenshots for any visual changes.
When to use - and when NOT to
Use it when writing a pull request description for a set of code changes - summarizing the change, classifying its type, documenting how it was tested, and checking off review-readiness items. It is not a code-review or commit-message prompt - it is scoped specifically to the PR description itself.
Inputs and outputs
Given a description of the code changes made, it produces a structured PR description with a summary, a change list, a change-type classification, a testing section, a checklist, and a linked related issue.
Who it's for
Developers writing pull request descriptions for review.
FAQ
Common questions
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.