173 lines
4.2 KiB
Markdown
173 lines
4.2 KiB
Markdown
## 📝 Description
|
|
|
|
<!--
|
|
Provide a clear and concise description of what this PR does.
|
|
Include the motivation and context for the change.
|
|
-->
|
|
|
|
### What changed?
|
|
<!-- Describe the changes in bullet points -->
|
|
-
|
|
-
|
|
-
|
|
|
|
### Why was this change needed?
|
|
<!-- Explain the problem this PR solves -->
|
|
|
|
|
|
## 🎫 Related Issue
|
|
|
|
<!-- Link to the Jira ticket or GitHub issue -->
|
|
Closes AUR-XXX
|
|
<!-- or -->
|
|
Related to #XXX
|
|
|
|
## 🔄 Type of Change
|
|
|
|
<!-- Mark the relevant option with an 'x' -->
|
|
|
|
- [ ] 🐛 Bug fix (non-breaking change fixing an issue)
|
|
- [ ] ✨ New feature (non-breaking change adding functionality)
|
|
- [ ] 💥 Breaking change (fix or feature causing existing functionality to break)
|
|
- [ ] 📝 Documentation update
|
|
- [ ] 🎨 Style/UI change (non-functional change)
|
|
- [ ] ♻️ Code refactoring (no functional changes)
|
|
- [ ] ⚡ Performance improvement
|
|
- [ ] ✅ Test addition/improvement
|
|
- [ ] 🔧 Configuration change
|
|
|
|
## 🧪 Testing
|
|
|
|
### How has this been tested?
|
|
|
|
<!-- Describe the tests you ran to verify your changes -->
|
|
|
|
**Test Environment:**
|
|
- OS: <!-- e.g., macOS, Ubuntu 22.04, Windows 11 -->
|
|
- Browser: <!-- e.g., Chrome 119, Safari 17, Firefox 120 -->
|
|
- Go version: <!-- e.g., 1.21.5 -->
|
|
- Node version: <!-- e.g., 18.18.0 -->
|
|
|
|
**Test Scenarios:**
|
|
<!-- List the scenarios you tested -->
|
|
1.
|
|
2.
|
|
3.
|
|
|
|
### Test Results
|
|
|
|
- [ ] All existing unit tests pass (`make test` / `npm test`)
|
|
- [ ] All existing integration tests pass
|
|
- [ ] New unit tests added (if applicable)
|
|
- [ ] New integration tests added (if applicable)
|
|
- [ ] Manual testing completed
|
|
- [ ] Edge cases tested
|
|
- [ ] Error handling tested
|
|
|
|
## 📸 Screenshots/Videos
|
|
|
|
<!--
|
|
For UI changes, add screenshots or videos showing before/after.
|
|
You can drag and drop images directly into this text area.
|
|
-->
|
|
|
|
### Before
|
|
<!-- Screenshot of old behavior -->
|
|
|
|
### After
|
|
<!-- Screenshot of new behavior -->
|
|
|
|
## ✅ Checklist
|
|
|
|
### Code Quality
|
|
|
|
- [ ] Code follows project style guidelines
|
|
- [ ] Self-review of code completed
|
|
- [ ] Comments added for complex/non-obvious code
|
|
- [ ] No debugging code left in (console.log, print statements)
|
|
- [ ] No commented-out code (unless with explanation)
|
|
- [ ] Variable and function names are descriptive
|
|
|
|
### Documentation
|
|
|
|
- [ ] README updated (if needed)
|
|
- [ ] API documentation updated (if endpoints changed)
|
|
- [ ] Code comments added for public APIs
|
|
- [ ] CHANGELOG updated (for user-facing changes)
|
|
|
|
### Testing
|
|
|
|
- [ ] Tests added/updated for changes
|
|
- [ ] All tests passing locally
|
|
- [ ] Code coverage not decreased
|
|
- [ ] Edge cases covered by tests
|
|
|
|
### Security & Performance
|
|
|
|
- [ ] No hardcoded secrets or credentials
|
|
- [ ] Input validation added where needed
|
|
- [ ] SQL injection protection verified (if DB changes)
|
|
- [ ] XSS protection verified (if frontend changes)
|
|
- [ ] No performance degradation
|
|
- [ ] Database queries optimized (if applicable)
|
|
|
|
### Database (if applicable)
|
|
|
|
- [ ] Migration files created
|
|
- [ ] Migration tested (up and down)
|
|
- [ ] Indexes added where needed
|
|
- [ ] RLS policies updated (if needed)
|
|
|
|
### Dependencies
|
|
|
|
- [ ] No unnecessary dependencies added
|
|
- [ ] New dependencies approved by team
|
|
- [ ] Package versions pinned (not using `^` or `~`)
|
|
- [ ] `go.mod`/`package.json` updated
|
|
|
|
### Breaking Changes (if applicable)
|
|
|
|
- [ ] Breaking changes documented
|
|
- [ ] Migration guide provided
|
|
- [ ] Backward compatibility considered
|
|
- [ ] Deprecation warnings added
|
|
|
|
## 🔗 Additional Context
|
|
|
|
<!--
|
|
Add any other context, design decisions, or trade-offs made.
|
|
Link to relevant documentation, ADRs, or discussions.
|
|
-->
|
|
|
|
## 🎯 Definition of Done
|
|
|
|
<!-- All items must be checked before merging -->
|
|
|
|
- [ ] Code review completed and approved
|
|
- [ ] All CI/CD checks passing
|
|
- [ ] No merge conflicts
|
|
- [ ] Branch is up to date with develop
|
|
- [ ] Documentation is complete
|
|
- [ ] QA/Testing completed (if required)
|
|
- [ ] Product owner approved (if user-facing)
|
|
|
|
## 🚀 Post-Merge Actions
|
|
|
|
<!-- Actions to take after merging -->
|
|
|
|
- [ ] Delete feature branch
|
|
- [ ] Update Jira ticket status
|
|
- [ ] Notify team in Slack
|
|
- [ ] Monitor production logs (if deploying)
|
|
|
|
---
|
|
|
|
**Reviewer Notes:**
|
|
<!-- Specific areas where you want reviewer feedback -->
|
|
-
|
|
-
|
|
|
|
**Deployment Notes:**
|
|
<!-- Special considerations for deployment -->
|
|
-
|
|
- |