Files
skills/public/pull_request_template.md

4.4 KiB

Pull Request Template

Description

What does this PR do?

Why is this change needed?

How does this work?

Type of Change

  • Bug fix (non-breaking change fixing an issue)
  • New feature (non-breaking change adding functionality)
  • Breaking change (fix or feature that breaks existing functionality)
  • Refactoring (no functional changes, just code restructuring)
  • Documentation update
  • Performance improvement
  • Security fix
  • Dependency update

Testing

How was this tested?

  • Unit tests added/updated
  • Integration tests added/updated
  • End-to-end tests added/updated
  • Manual testing performed

Test Coverage

Coverage: XX%
Critical paths: XX%

Manual Testing Steps

Checklist

Code Quality

  • Code follows project style guidelines
  • Self-review completed
  • Code is self-documenting or has comments for complex logic
  • No debug statements (console.log, print, etc.)
  • No commented-out code
  • Error handling is appropriate

Testing

  • All new and existing tests pass locally
  • Test coverage meets requirements (>70%)
  • Edge cases are tested
  • Error cases are tested

Documentation

  • Public APIs have documentation/comments
  • README updated if needed
  • CHANGELOG updated
  • Breaking changes documented
  • Migration guide provided (if breaking changes)

Dependencies

  • Dependencies are up-to-date
  • No new security vulnerabilities introduced
  • License compatibility checked
  • Dependency versions pinned appropriately

Security

  • No secrets or credentials in code
  • Input validation added where needed
  • Authentication/authorization checked
  • Security best practices followed

Performance

  • No performance regressions
  • Database queries optimized (no N+1 queries)
  • Appropriate caching implemented
  • Large datasets handled efficiently
  • Fixes #
  • Related to #
  • Closes #

Breaking Changes

What breaks?

Migration Path

# Before
old_code_example()

# After
new_code_example()

Screenshots/Videos

Before

After

Deployment Notes

  • Database migrations required
  • Environment variables need updating
  • Feature flags required
  • Cache needs clearing
  • CDN needs invalidation
  • Background jobs need restarting
  • Configuration changes needed

Rollback Plan

Performance Impact

Before

After

Additional Context

Design Decisions

Trade-offs

Future Work

Reviewer Notes

Focus Areas

Questions for Reviewers


Ready for Review:

Merge Strategy:

Target Milestone: