xixu-me
8afa94767e
Add configuration, documentation, code of conduct, contributing guide, license, and README files. Set up .gitignore, coverage config, GitHub issue templates, pull request template, and initial source code, scripts, and tests for DeepLX optimized for Cloudflare Workers.
194 lines
4.8 KiB
Markdown
194 lines
4.8 KiB
Markdown
# Pull Request
|
|
|
|
## Description
|
|
<!-- Provide a clear and concise description of your changes -->
|
|
|
|
## Type of Change
|
|
<!-- Mark the relevant option with an "x" -->
|
|
|
|
- [ ] 🐛 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
|
|
<!-- Link to related issues, use "Closes #123" to auto-close issues -->
|
|
|
|
- Closes #
|
|
- Related to #
|
|
|
|
## Changes Made
|
|
<!-- List the specific changes made in this PR -->
|
|
|
|
-
|
|
-
|
|
-
|
|
|
|
## Testing
|
|
<!-- Describe how you tested your changes -->
|
|
|
|
### Test Coverage
|
|
|
|
- [ ] Unit tests added/updated
|
|
- [ ] Integration tests added/updated
|
|
- [ ] Performance tests added/updated
|
|
- [ ] Manual testing completed
|
|
|
|
### Test Results
|
|
<!-- Include test results or screenshots if applicable -->
|
|
|
|
```bash
|
|
# Test command and results
|
|
npm test
|
|
```
|
|
|
|
## Performance Impact
|
|
<!-- Describe any performance implications -->
|
|
|
|
- [ ] No performance impact
|
|
- [ ] Performance improvement
|
|
- [ ] Potential performance regression (explain below)
|
|
|
|
**Performance Details:**
|
|
<!-- Add details about performance changes if applicable -->
|
|
|
|
## Security Considerations
|
|
<!-- Address any security implications -->
|
|
|
|
- [ ] No security implications
|
|
- [ ] Security improvement
|
|
- [ ] Potential security impact (explain below)
|
|
|
|
**Security Details:**
|
|
<!-- Add details about security changes if applicable -->
|
|
|
|
## Breaking Changes
|
|
<!-- Describe any breaking changes and migration path -->
|
|
|
|
- [ ] No breaking changes
|
|
- [ ] Breaking changes included (describe below)
|
|
|
|
**Breaking Change Details:**
|
|
<!-- Describe breaking changes and provide migration guide -->
|
|
|
|
## Documentation
|
|
<!-- Check all that apply -->
|
|
|
|
- [ ] 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
|
|
<!-- Check if any configuration changes are needed -->
|
|
|
|
- [ ] No configuration changes
|
|
- [ ] New configuration options added
|
|
- [ ] Existing configuration changed
|
|
- [ ] Environment variables added/changed
|
|
|
|
**Configuration Details:**
|
|
<!-- Describe configuration changes if applicable -->
|
|
|
|
## Dependencies
|
|
<!-- Check if dependencies were modified -->
|
|
|
|
- [ ] No dependency changes
|
|
- [ ] Dependencies added
|
|
- [ ] Dependencies updated
|
|
- [ ] Dependencies removed
|
|
|
|
**Dependency Changes:**
|
|
<!-- List dependency changes if applicable -->
|
|
|
|
## Deployment Notes
|
|
<!-- Any special deployment considerations -->
|
|
|
|
- [ ] No special deployment requirements
|
|
- [ ] Requires environment variable updates
|
|
- [ ] Requires configuration changes
|
|
- [ ] Requires database migrations
|
|
- [ ] Requires infrastructure changes
|
|
|
|
**Deployment Details:**
|
|
<!-- Add deployment instructions if applicable -->
|
|
|
|
## Screenshots/Media
|
|
<!-- Add screenshots, GIFs, or other media if applicable -->
|
|
|
|
## Checklist
|
|
<!-- Ensure all items are completed before requesting review -->
|
|
|
|
### 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
|
|
<!-- Add any additional context, concerns, or notes for reviewers -->
|
|
|
|
## Review Guidelines
|
|
<!-- For reviewers -->
|
|
|
|
**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:**
|
|
<!-- Add any specific questions or areas you'd like feedback on -->
|
|
|
|
-
|
|
-
|
|
|
|
---
|
|
|
|
<!--
|
|
Thank you for contributing to DeepLX! 🚀
|
|
|
|
Please ensure you have read and followed our [Contributing Guidelines](../CONTRIBUTING.md).
|
|
|
|
For questions about this PR, please comment below or reach out in the related issue.
|
|
-->
|