xget/.github/pull_request_template.md

Pull Request

📋 变更概述

变更类型

请选择适用的类型：

• 🐛 Bug 修复
• ✨ 新功能
• 📚 文档更新
• 🎨 代码格式化/重构
• ⚡ 性能优化
• 🧪 测试相关
• 🔧 构建/配置更改
• 🌐 新平台支持

变更描述

简要描述此 PR 的主要变更内容：

相关 Issue

关联的 Issue 编号（如果有）：

• Closes #
• Fixes #
• Related to #

🔍 详细说明

变更内容

详细描述您所做的更改：

实现方法

说明您是如何实现这些更改的：

影响范围

这些更改会影响哪些部分：

• 核心代理逻辑
• 平台配置
• 安全机制
• 缓存策略
• 性能监控
• 文档
• 测试
• 其他：

🧪 测试

测试环境

• 本地开发环境
• Cloudflare Workers 测试环境
• 生产环境（如适用）

测试用例

描述您进行的测试：

功能测试

• 基本功能正常工作
• 边界情况处理正确
• 错误处理机制有效

平台测试（如适用）

• GitHub 文件下载
• GitLab 文件下载
• Hugging Face 模型下载
• npm 包下载
• PyPI 包下载
• conda 包下载
• Git 操作（clone/push/pull）

性能测试

• 响应时间在可接受范围内
• 缓存机制工作正常
• 内存使用合理

测试结果

提供测试结果或截图：

📝 检查清单

代码质量

• 代码遵循存储库编码规范
• 添加了必要的注释
• 没有遗留的调试代码
• 处理了所有可能的错误情况

测试覆盖

• 为新功能添加了测试用例
• 所有测试都通过
• 测试覆盖率没有显著下降

文档更新

• 更新了相关的 README 部分
• 更新了 API 文档（如适用）
• 添加了使用示例（如适用）
• 更新了配置说明（如适用）

兼容性

• 向后兼容现有功能
• 不会破坏现有的 API
• 考虑了不同平台的兼容性

🚀 部署注意事项

配置变更

是否需要更新配置：

• 无需配置变更
• 需要更新环境变量
• 需要更新 wrangler.toml
• 需要更新平台配置

部署风险

评估部署风险：

• 低风险 - 仅文档或小幅改进
• 中风险 - 功能增强或重构
• 高风险 - 核心逻辑变更

回滚计划

如果需要回滚，说明回滚步骤：

📊 性能影响

性能指标

如果涉及性能变更，请提供相关数据：

响应时间

• 变更前：
• 变更后：
• 改进幅度：

内存使用

• 变更前：
• 变更后：
• 变化情况：

缓存效率

• 缓存命中率变化：
• 缓存策略优化：

🔒 安全考虑

安全影响

• 此变更不涉及安全问题
• 此变更增强了安全性
• 此变更可能有安全影响（请详细说明）

安全检查

• 输入验证充分
• 输出编码正确
• 权限控制适当
• 敏感信息保护

📸 截图/演示

如果适用，请提供截图或演示链接：

💬 其他说明

已知问题

列出任何已知的问题或限制：

后续工作

描述可能的后续改进或相关工作：

特别说明

任何需要审查者特别注意的地方：

---

审查者检查清单

代码审查

• 代码逻辑正确
• 代码风格一致
• 性能考虑充分
• 安全措施到位

功能验证

• 功能按预期工作
• 边界情况处理正确
• 错误处理完善

文档检查

• 文档更新完整
• 示例代码正确
• 配置说明清晰

测试验证

• 测试用例充分
• 测试结果可信
• 覆盖率满足要求

---

感谢您的贡献！🎉