.github/pull_request_template.md

Description

Brief description of the changes in this PR.

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Code refactoring
• Performance improvement
• Test addition/update

Related Issues

Closes #(issue number) Related to #(issue number)

Changes Made

• List specific changes made
• Include any new files or major modifications
• Mention any removed functionality

Testing

• I have tested this locally
• I have added/updated unit tests
• I have added/updated integration tests
• I have tested with Docker
• All existing tests pass

Documentation

• I have updated relevant documentation
• I have added JSDoc comments for new public APIs
• I have updated the README if needed
• I have updated the CHANGELOG if needed

Code Quality

• My code follows the project's style guidelines
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• My changes generate no new warnings or errors

Breaking Changes

If this is a breaking change, please describe:

1. What breaks:
2. How users should migrate:
3. Why this change is necessary:

Screenshots (if applicable)

Include screenshots or GIFs for UI changes.

Additional Notes

Any additional information, concerns, or context for reviewers.

---

Reviewer Checklist

• Code follows project conventions and style
• Changes are well-tested
• Documentation is updated appropriately
• No security concerns
• Performance impact is acceptable
• Breaking changes are properly documented