aurganize-backend/.github/pull_request_template.md

📝 Description

What changed?

Why was this change needed?

🎫 Related Issue

Closes AUR-XXX

Related to #XXX

🔄 Type of Change

• 🐛 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?

Test Environment:

• OS:
• Browser:
• Go version:
• Node version:

Test Scenarios:

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

Before

After

✅ 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

🎯 Definition of Done

• 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

• Delete feature branch
• Update Jira ticket status
• Notify team in Slack
• Monitor production logs (if deploying)

---

Reviewer Notes:

Deployment Notes: