rxminder/.github/pull_request_template.md

Pull Request

📝 Description

Brief description of changes made in this pull request.

🔗 Related Issues

Fixes #(issue_number) Closes #(issue_number) Related to #(issue_number)

🎯 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
• 🔧 Code refactoring (no functional changes)
• ⚡ Performance improvement
• 🧪 Test coverage improvement
• 🔒 Security enhancement
• 🎨 UI/UX improvement

🧪 Testing

Describe the tests you ran to verify your changes.

Test Environment

• Local development
• Docker environment
• Production-like environment

Test Cases

• Unit tests pass
• Integration tests pass
• Manual testing completed
• Cross-browser testing (if UI changes)
• Mobile testing (if responsive changes)
• Accessibility testing (if UI changes)

New Tests Added

• Unit tests for new functionality
• Integration tests for API changes
• End-to-end tests for user flows

📱 Screenshots (if applicable)

Include screenshots for UI changes.

Before

[Add screenshot of current state]

After

[Add screenshot of new state]

Mobile View

[Add mobile screenshots if applicable]

🔒 Security Considerations

• No sensitive data exposed in logs
• Authentication/authorization properly implemented
• Input validation in place
• SQL injection prevention (if applicable)
• XSS prevention (if applicable)
• CSRF protection maintained

📊 Performance Impact

• No performance degradation
• Performance improvements measured
• Database queries optimized
• Bundle size impact acceptable
• Memory usage acceptable

🔄 Breaking Changes

If this is a breaking change, describe:

1. What breaks
2. Migration path for users
3. Version bump requirements

📚 Documentation

• Code is self-documenting with clear naming
• Complex logic has comments
• API documentation updated (if applicable)
• README updated (if applicable)
• User documentation updated (if applicable)

📋 Checklist

Code Quality

• Code follows project style guidelines
• Self-review of code completed
• Code is commented where necessary
• No console.log statements left in code
• Error handling implemented properly

Testing & Validation

• All tests pass locally
• TypeScript compilation succeeds
• ESLint passes without errors
• Build succeeds without warnings
• Manual testing completed

Review Preparation

• Pull request title is descriptive
• Pull request description is complete
• Commits are atomic and well-described
• No merge conflicts
• Base branch is correct

Deployment Readiness

• Environment variables documented (if new)
• Database migrations included (if needed)
• Docker configuration updated (if needed)
• Deployment scripts updated (if needed)

🎯 Review Focus Areas

Please pay special attention to:

• Security implications
• Performance impact
• Error handling
• User experience
• Code maintainability
• Test coverage

📝 Additional Notes

Any additional information for reviewers:

Design Decisions

Explain any significant design or architecture decisions made.

Trade-offs

Describe any trade-offs made and why they were necessary.

Future Work

List any follow-up work that should be done in future PRs.

🚀 Deployment Notes

Special considerations for deployment:

• Requires environment variable changes
• Requires database migration
• Requires cache clearing
• Requires dependency updates
• No special deployment requirements

---

Reviewer Checklist:

• Code review completed
• Tests reviewed and verified
• Documentation reviewed
• Security review completed (if applicable)
• Performance review completed (if applicable)
• Breaking changes noted and approved
• Deployment considerations reviewed