PR Templates
π― PR Templates Overview
We use standardized PR templates to ensure consistency and completeness in our pull requests. Each template is designed for specific types of changes and includes relevant checklists and guidelines.
π Available Templates
π« Git Issue Ticket Template
Use for: Creating GitHub issues and tickets
- Issue description and type
- Acceptance criteria
- Labels and assignees
- Related issues and milestones
π PR Template
Use for: All pull requests (frontend & backend)
- Unified template for all PR types
- Testing checklist
- Self-review checklist
- Deployment notes and context
π Spike/Feature R&D Template
Use for: Research, exploration, and feature development
- Research objectives and scope
- Methodology and approach
- Findings and recommendations
- Risk assessment and decision points
π Bug Reporting Template
Use for: Reporting bugs and issues
- Issue description and reproduction steps
- Environment information
- Impact assessment
- Screenshots and evidence
π― How to Use Templates
1. Choose the Right Template
Select the template that best matches your type of change:
- Creating issues β Git Issue Ticket Template
- All pull requests β PR Template
- Research/exploration β Spike/Feature R&D Template
- Reporting bugs β Bug Reporting Template
2. Copy the Template
Copy the markdown template from the relevant page and paste it into your PR description.
3. Fill Out the Sections
Complete all relevant sections with specific information about your changes.
4. Use the Checklists
Check off items as you complete them to ensure nothing is missed.
π Template Benefits
Consistency
- Standardized format across all PRs
- Consistent information gathering
- Uniform review process
Completeness
- Comprehensive checklists
- Nothing important gets missed
- Better quality assurance
Efficiency
- Faster review process
- Clear expectations
- Reduced back-and-forth
Documentation
- Self-documenting changes
- Historical record of decisions
- Knowledge sharing
π Template Evolution
These templates are living documents that evolve with our team needs:
- Regular Reviews: Templates are reviewed quarterly
- Feedback Integration: Team feedback is incorporated
- Best Practices: Updated based on industry standards
- Tool Integration: Adapted for new tools and processes
Choose the appropriate template for your PR type to ensure thorough and consistent pull request documentation.
Last Updated: September 9, 2025 by @drhinca: AdriΓ‘n Bado Chinca