Generate Pull Request Descriptions
Generate comprehensive pull request descriptions with a structured template, ensuring clarity and context for code reviews.
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 Use cases
What you can do with it
Writes source code or scripts from a description.
Analyzes code for bugs, style issues, and improvements.
Drafts marketing, email, or product copy on demand.
Overview
PR Description Generator
What it does
This AI prompt generates a comprehensive pull request (PR) description based on provided code changes. It utilizes a structured markdown template to ensure all necessary information for reviewers is included, such as a summary, detailed changes, type of change, testing methods, and related issues.
How it connects
Use this prompt when you need to create a clear, concise, and informative pull request description. It is ideal for ensuring consistency in your team's code review process and providing essential context for reviewers.
Source README
Generate a pull request description for the following changes.
PR Description 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
- Be concise but comprehensive
- Focus on the "why" not just the "what"
- Include context for reviewers
- Link related issues and documentation
- Add screenshots for visual changes
Provide the changes and I'll generate an appropriate PR description.
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.