pull_request_template.md

September 24, 2025 · View on GitHub

Pull Request Description

What does this PR do?

Related Issue(s):

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 change)
  • 📚 Documentation update (changes to docs only)
  • 🎨 Style changes (formatting, renaming, etc. no functional changes)
  • ♻️ Refactoring (code change that neither fixes a bug nor adds a feature)
  • ⚡ Performance improvement
  • 🧪 Test changes (adding or updating tests)
  • 🔧 Build/CI changes (changes to build process, CI, or dev tools)
  • 🧹 Chore (dependency updates, cleanup, etc.)

Changes Made

Added

  • New feature A
  • New component B

Changed

  • Modified behavior of X
  • Updated Y for better Z

Removed

  • Deprecated feature A
  • Unused code B

Fixed

  • Issue with X
  • Bug in Y

Testing

Test Coverage

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

Test Commands Used

# Commands used to test these changes
npm test
npm run test:integration

Testing Checklist

  • All existing tests pass
  • New tests added for new functionality
  • Edge cases considered and tested
  • Performance impact assessed

Documentation

  • Code comments added/updated
  • README.md updated
  • API documentation updated
  • CHANGELOG.md updated
  • Migration guide added (if breaking changes)
  • Examples added/updated

Screenshots/Demo

Before:

After:

Breaking Changes

  • This PR does not introduce any breaking changes

If breaking changes exist:

What breaks?

Migration path

Timeline

Performance Impact

  • No performance impact
  • Improves performance
  • May impact performance (please describe)

Performance notes:

Security Considerations

  • No security implications
  • Security review needed
  • This fixes a security issue

Security notes:

Deployment Notes

  • No special deployment requirements
  • Database migrations required
  • Environment variables changes needed
  • Configuration changes required
  • Special deployment steps needed

Deployment instructions:

Checklist

Code Quality

  • Code follows the project's style guidelines
  • Self-review completed
  • Code is properly documented
  • No console.log or debug code left behind
  • Error handling implemented where needed

Testing

  • All tests pass locally
  • New tests written for new functionality
  • Existing tests updated if necessary
  • Manual testing completed

Documentation

  • Relevant documentation updated
  • Code comments added where necessary
  • API changes documented
  • Breaking changes documented

Review

  • PR title follows conventional commit format
  • PR description is clear and complete
  • Changes are focused and atomic
  • Ready for review

Review Notes

Focus Areas:

Questions for Reviewers:

Known Issues/TODOs:

Additional Context

References:

Dependencies:

🚀 Ready for Review

  • This PR is ready for review
  • This PR is a work in progress (convert to draft)