pull_request_template.md

Pull Request

Description

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
• 🔧 Refactoring (no functional changes, no api changes)
• ⚡ Performance improvement
• 🔒 Security improvement
• 🧪 Test coverage improvement
• 🚀 CI/CD pipeline improvement
• 🏗️ Infrastructure change

Components Affected

• Catalog Service
• Basket Service
• Discount Service
• Ordering Service
• API Gateway (Ocelot)
• Frontend (React/Nx Micro-frontends)
• Database migrations
• Kubernetes/Helm charts
• Docker configurations
• CI/CD workflows
• Documentation

Changes Made

Related Issues

Fixes #(issue_number) Closes #(issue_number) Relates to #(issue_number)

Testing

Test Coverage

• Unit tests added/updated
• Integration tests added/updated
• E2E tests added/updated
• Manual testing completed

Test Steps

Performance Impact

• No performance impact
• Performance improvement
• Potential performance impact (explain below)

Security Considerations

• No security impact
• Security improvement
• Potential security impact (explain below)

Breaking Changes

Documentation

• Code is self-documenting
• README updated
• API documentation updated
• Deployment guide updated
• Architecture documentation updated

Deployment Notes

Environment Variables

Database Changes

• No database changes
• Migration scripts included
• Backward compatible changes
• Breaking database changes (migration plan attached)

Configuration Changes

• No configuration changes
• Helm values updated
• Docker compose updated
• Kubernetes manifests updated

Screenshots

Checklist

Code Quality

• My code follows the project's style guidelines
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• My changes generate no new warnings or errors
• New and existing unit tests pass locally with my changes

Documentation

• I have made corresponding changes to the documentation
• My changes are covered by tests

Dependencies

• I have checked that my changes don't introduce security vulnerabilities
• Any dependent changes have been merged and published

Review

• I have requested review from appropriate team members
• This PR is ready for review

Additional Notes

---

For Reviewers

Review Checklist

• Code quality and style
• Test coverage is adequate
• Documentation is updated
• Security implications considered
• Performance impact assessed
• Breaking changes identified and documented

Approval Criteria

• Functionality works as expected
• Tests pass
• No security concerns
• Documentation is adequate
• Ready for deployment