Detailed PR Template with Screenshots Section
A comprehensive PR template that includes all sections plus a before/after screenshot comparison table. Ideal for frontend and UI-heavy projects.
Detailed Explanation
Detailed PR Template with Screenshots
For frontend, mobile, or design-heavy projects, visual context is critical during code review. A detailed template with a dedicated Screenshots section helps reviewers understand UI changes without pulling the branch locally.
Template Structure
## Description
<!-- Summarize the changes and motivation. Link the design spec if available. -->
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Code refactoring
- [ ] Style/UI changes
- [ ] Documentation update
## Screenshots
| Before | After |
|--------|-------|
| | |
## Checklist
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have commented my code in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective
- [ ] New and existing unit tests pass locally
- [ ] Dependent changes have been merged
- [ ] I have checked my code with a linter
## Testing
<!-- Describe testing steps so reviewers can reproduce. -->
## Related Issues
<!-- Fixes #(issue number) -->
The Screenshots Table
The before/after table uses standard Markdown table syntax. Contributors drag-and-drop images directly into the GitHub PR editor, and GitHub hosts them automatically. The two-column layout makes visual comparisons easy.
Extended Checklist
The detailed template includes additional checklist items beyond the standard set:
- Dependent changes merged — prevents merge conflicts from interleaved PRs
- Linter check — catches style issues before CI runs
- Hard-to-understand code comments — improves long-term maintainability
When to Use This Template
This template shines in projects where:
- UI components are frequently modified
- Design reviews happen as part of the PR process
- The team includes designers who review visual changes
- Accessibility testing requires visual verification
Use Case
A frontend or full-stack team working on a React/Next.js application where UI changes need visual review. Also valuable for mobile app projects where screenshots demonstrate the impact of layout changes.