PR Template
π PR Template
Unified Template for Frontend & Backend
## π Description
Brief description of what this PR accomplishes and why it's needed.
## π― 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 (handbook, readme, instructions)
- [ ] π¨ Code style update (formatting, missing semi colons, etc; no logic change)
- [ ] β»οΈ Code refactoring (no functional changes)
- [ ] β‘ Performance improvement (no feature itself)
- [ ] β
Test addition or update
- [ ] π§ Configuration in the repo change
- [ ] π CI/CD or deployment change
## π Related Issues
Closes #[issue number]
Fixes #[issue number]
Related to #[issue(s) number]
## π§ͺ Testing
- [ ] Unit tests
- [ ] Integration tests
- [ ] Manual testing completed
- [ ] Cross-browser testing (frontend)
- [ ] API testing (backend)
## πΈ Screenshots / Video / Evidence working (if applicable)
Add audio/visuals as needed
## π Self-Checklist
- [ ] Pre-commit is green
- [ ] Code follows our style guidelines
- [ ] Self-review of task completed
- [ ] PR is open in draft ASAP for feedback
- [ ] Granular & conventional commits
- [ ] Documentation updated (if applicable)
- [ ] Tests added/updated (if applicable)
- [ ] No console errors or warnings introduced
- [ ] No TODOs without explanation or follow-up tickets
- [ ] Performance impact considered
- [ ] Security implications reviewed
- [ ] Holistic-platform implications reviewed
- [ ] PR template is ready to be shared & green!
## π Deployment Notes
Any special deployment considerations or database migrations needed.
## π Additional Context
Any additional information that reviewers should know about this change.
### SQL to be run (if applicable):
```sql
ALTER TABLE users ADD COLUMN email_verified BOOLEAN DEFAULT FALSE;
UPDATE users SET email_verified = TRUE WHERE created_at < '2024-01-01';
BASH commands to be run (if applicable):
npm run build:production
docker-compose restart api-service
JSON schemas (if applicable):
{
"type": "object",
"properties": {
"userId": {"type": "string"},
"preferences": {
"type": "object",
"properties": {
"notifications": {"type": "boolean"}
}
}
}
}
---
## π **Usage Guidelines**
### **When to Use This Template**
- **All PRs**: Use this template for every pull request
- **Frontend Changes**: React, Vue, Angular, CSS, HTML changes
- **Backend Changes**: API, database, server-side logic changes
- **Full-Stack Changes**: Changes affecting both frontend and backend
### **Best Practices**
- **Complete Description**: Explain what and why
- **Link Issues**: Always link related issues
- **Comprehensive Testing**: Test all scenarios
- **Self-Review**: Review your own code first
- **Documentation**: Update docs when needed
### **Success Criteria**
- All checklist items completed
- Tests pass
- Code follows style guidelines
- Documentation updated
- Ready for review
---
*This unified template works for both frontend and backend changes, ensuring consistency across all PRs.*
---
**Last Updated**: September 9, 2025 by @drhinca: AdriΓ‘n Bado Chinca