Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
170 lines (118 loc) · 3.85 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

170 lines (118 loc) · 3.85 KB

Description

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update
  • 🎨 UI/UX improvement
  • ⚡ Performance improvement
  • ♻️ Code refactoring
  • 🧪 Test addition or update
  • 🔧 Configuration change

Related Issues

Closes #

Changes Made

Testing

Test Coverage

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

Test Steps

Test Results

# Example: paste test output here

Documentation

  • Updated relevant README files
  • Updated API documentation
  • Updated agent instructions (.claude/teams/)
  • Created/updated ADR (if architecture change)
  • Updated CHANGELOG.md
  • Added code comments for complex logic
  • Updated environment variable documentation

Screenshots/Videos

Checklist

Code Quality

  • Code follows project style guidelines
  • TypeScript types are properly defined
  • No console.log or debug code left in
  • Error handling is implemented
  • Code is DRY (Don't Repeat Yourself)

Testing

  • All tests pass locally
  • Test coverage maintained or improved
  • Edge cases are covered

Documentation

  • CHANGELOG.md updated (unless skip-changelog label)
  • Relevant documentation updated
  • Comments added for complex logic

Security

  • No sensitive data exposed
  • Input validation implemented
  • Authentication/authorization checked
  • Dependencies are secure (no known vulnerabilities)

Performance

  • No unnecessary re-renders (React)
  • Database queries optimized
  • No N+1 query issues
  • Bundle size impact considered

Accessibility

  • ARIA labels added where needed
  • Keyboard navigation works
  • Color contrast is sufficient
  • Screen reader tested (if UI change)

Breaking Changes

Impact:

Migration Path:

Deployment Notes

  • Database migration required
  • Environment variables added/changed
  • External service configuration needed
  • Cache needs to be cleared
  • Other (describe):

Rollback Plan

Agent Team Review

Requesting review from:

  • @platform-engineering-team
  • @frontend-team
  • @ai-agents-team
  • @data-infrastructure-team
  • @product-planning-team
  • @quality-docs-team

Additional Context

Reviewer Guidelines

What to Look For

  1. Correctness: Does the code do what it claims?
  2. Testing: Are there adequate tests?
  3. Documentation: Is it well-documented?
  4. Performance: Any performance concerns?
  5. Security: Any security issues?
  6. Maintainability: Is the code maintainable?

Approval Criteria

  • ✅ All CI checks pass
  • ✅ Code review approval from at least 1 team member
  • ✅ Documentation updated
  • ✅ Tests pass and coverage maintained
  • ✅ No unresolved comments