Skip to main content

🔄 Pull Request Template

Standardized template for creating comprehensive pull request descriptions.

📋 Template Format​

Copy and paste this template when creating pull requests:

## 📝 Summary

Brief description of the changes in this pull request.

## 🔧 Type of Change

- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
- [ ] ✨ New feature (non-breaking change which adds functionality)
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] 📚 Documentation update
- [ ] 🎨 Style/UI changes
- [ ] ♻️ Code refactoring (no functional changes)
- [ ] ⚡ Performance improvements
- [ ] 🧪 Test additions or modifications
- [ ] 🔧 Build/CI changes
- [ ] 🏗️ Infrastructure changes

## 🎯 Related Issues

Closes #[issue_number]
Fixes #[issue_number]
Relates to #[issue_number]

## 🚀 Changes Made

### Added

- New feature or functionality
- New components or utilities
- New documentation

### Changed

- Modified existing functionality
- Updated dependencies
- Improved performance

### Removed

- Deprecated features
- Unused code or files
- Outdated documentation

### Fixed

- Bug fixes
- Security vulnerabilities
- Performance issues

## 🧪 Testing

### Test Coverage

- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] E2E tests added/updated
- [ ] Manual testing completed

### Testing Checklist

- [ ] All existing tests pass
- [ ] New tests cover the changes
- [ ] Edge cases are tested
- [ ] Error handling is tested

### Manual Testing Steps

1. Step-by-step instructions for manual testing
2. Expected behavior and results
3. Any specific test data or setup required

## 📱 Screenshots/Videos

### Before

[Screenshot or description of current state]

### After

[Screenshot or description of new state]

### Demo

[Link to demo video or GIF if applicable]

## 🔒 Security Considerations

- [ ] No sensitive data exposed
- [ ] Input validation implemented
- [ ] Authentication/authorization checked
- [ ] Security headers configured
- [ ] Dependencies scanned for vulnerabilities

## 📊 Performance Impact

- [ ] No performance regression
- [ ] Performance improvements measured
- [ ] Bundle size impact assessed
- [ ] Database query optimization verified

## 🌐 Browser/Device Testing

- [ ] Chrome
- [ ] Firefox
- [ ] Safari
- [ ] Edge
- [ ] Mobile devices
- [ ] Tablet devices

## 📚 Documentation

- [ ] Code comments added/updated
- [ ] README updated
- [ ] API documentation updated
- [ ] User documentation updated
- [ ] Migration guide created (if needed)

## 🔄 Migration Notes

[Include any migration steps, database changes, or breaking changes]

## ✅ Pre-merge Checklist

### Code Quality

- [ ] Code follows project style guidelines
- [ ] Self-review completed
- [ ] Code is well-commented
- [ ] No console.log or debug code left
- [ ] TypeScript types are properly defined

### Testing

- [ ] All tests pass locally
- [ ] CI/CD pipeline passes
- [ ] Code coverage meets requirements
- [ ] Manual testing completed

### Documentation

- [ ] Documentation updated
- [ ] Breaking changes documented
- [ ] API changes documented
- [ ] User-facing changes documented

### Security

- [ ] Security review completed
- [ ] No sensitive data in code
- [ ] Dependencies are secure
- [ ] Authentication/authorization tested

### Performance

- [ ] Performance impact assessed
- [ ] Bundle size checked
- [ ] Database queries optimized
- [ ] Caching implemented where appropriate

## 🤝 Review Requests

### Specific Areas for Review

- [ ] Architecture/design decisions
- [ ] Security implementation
- [ ] Performance optimizations
- [ ] User experience
- [ ] Accessibility compliance

### Questions for Reviewers

1. Specific questions about implementation choices
2. Areas where you need feedback
3. Alternative approaches to consider

## 🔗 Additional Context

[Any additional context, background information, or links that would help reviewers understand the changes]

## 📋 Deployment Notes

### Pre-deployment

- [ ] Database migrations ready
- [ ] Environment variables configured
- [ ] Feature flags configured
- [ ] Monitoring alerts updated

### Post-deployment

- [ ] Health checks verified
- [ ] Performance metrics monitored
- [ ] Error rates monitored
- [ ] User feedback collected

---

**Reviewer Guidelines:**

- Review for code quality, security, and performance
- Test the changes locally if possible
- Check documentation completeness
- Verify breaking changes are properly documented
- Ensure tests cover the new functionality

💡 Usage Tips​

1. Customize for Your PR​

Not all sections are required for every PR. Remove or modify sections as needed:

  • Small bug fixes: Focus on summary, testing, and fixes
  • New features: Include all sections thoroughly
  • Documentation updates: Emphasize documentation and review sections
  • Refactoring: Focus on changes made and testing

2. Be Specific​

Provide detailed information:

  • Use clear, descriptive language
  • Include code examples when helpful
  • Reference specific files or functions
  • Explain the reasoning behind decisions

3. Visual Evidence​

Include screenshots or videos when:

  • UI changes are involved
  • Complex workflows are modified
  • Before/after comparisons are helpful
  • Demonstrating new functionality

🔧 Automation Integration​

GitHub Integration​

This template can be automatically applied by creating .github/pull_request_template.md:

<!-- Copy the template content here -->

Custom Templates​

Create multiple templates for different types of PRs:

.github/
  PULL_REQUEST_TEMPLATE/
    feature.md
    bugfix.md
    documentation.md
    hotfix.md

📊 Template Benefits​

For Authors​

  • Structured thinking: Ensures all aspects are considered
  • Complete information: Provides reviewers with necessary context
  • Consistent format: Makes PRs easier to read and review
  • Quality assurance: Built-in checklists prevent oversights

For Reviewers​

  • Clear context: Understand the purpose and scope
  • Testing guidance: Know what to test and verify
  • Risk assessment: Identify potential issues early
  • Efficient review: Focus on the most important aspects

For Teams​

  • Knowledge sharing: Document decisions and reasoning
  • Process improvement: Identify common issues and patterns
  • Quality metrics: Track completion of checklists
  • Onboarding: Help new team members understand expectations

This template is designed to improve code review quality and team communication. Adapt it to your team's specific needs and workflow.