deeplx/.github/pull_request_template.md

Pull Request

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
• 🎨 Code style/formatting change
• ♻️ Code refactoring (no functional changes)
• ⚡ Performance improvement
• 🧪 Test updates
• 🔧 Build/CI changes
• 🔒 Security improvement

Related Issues

• Closes #
• Related to #

Changes Made

Testing

Test Coverage

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

Test Results

# Test command and results
npm test

Performance Impact

• No performance impact
• Performance improvement
• Potential performance regression (explain below)

Performance Details:

Security Considerations

• No security implications
• Security improvement
• Potential security impact (explain below)

Security Details:

Breaking Changes

• No breaking changes
• Breaking changes included (describe below)

Breaking Change Details:

Documentation

• Code is self-documenting
• Added/updated inline comments
• Added/updated JSDoc comments
• Updated README.md
• Updated API documentation
• Added/updated examples
• Updated CHANGELOG.md

Configuration Changes

• No configuration changes
• New configuration options added
• Existing configuration changed
• Environment variables added/changed

Configuration Details:

Dependencies

• No dependency changes
• Dependencies added
• Dependencies updated
• Dependencies removed

Dependency Changes:

Deployment Notes

• No special deployment requirements
• Requires environment variable updates
• Requires configuration changes
• Requires database migrations
• Requires infrastructure changes

Deployment Details:

Screenshots/Media

Checklist

Code Quality

• Code follows the repository's style guidelines
• Self-review of the code completed
• Code is properly formatted
• No console.log or debug statements left
• Error handling is appropriate
• Code is optimized for Cloudflare Workers environment

Test Execution

• All existing tests pass
• New tests added for new functionality
• Tests cover edge cases
• Integration tests pass
• Performance tests pass (if applicable)

Documentation Updates

• Documentation updated (if applicable)
• Code comments added where necessary
• API documentation updated (if applicable)
• Examples updated (if applicable)

Review Readiness

• PR title follows conventional commit format
• PR description is clear and complete
• Related issues are linked
• PR is ready for review
• Requested reviewers assigned

Additional Context

Review Guidelines

Focus Areas:

• Code correctness and logic
• Performance implications
• Security considerations
• Test coverage and quality
• Documentation completeness
• Breaking change impact
• API design consistency

Questions for Discussion:

---