laoxong/nofx
1
0
Fork 0
mirror of https://github.com/laoxong/nofx.git synced 2026-06-04 09:58:22 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
8b004bf4dc53d143d338a33df04420e690f8102d
nofx/.github/PULL_REQUEST_TEMPLATE.md
T
zbhan 52295c69ad fix(readme): update readme and pr reviewer
2025-11-03 20:50:56 -05:00

9.2 KiB
Raw Blame History

Pull Request | PR 提交

💡 提示 Tip: 推荐 PR 标题格式 Recommended PR title format: type(scope): description 例如 Examples: feat(trader): add new strategy | fix(api): resolve auth issue 详情 Details: PR Title Guide

📝 Description | 描述

English:

中文：

🎯 Type of Change | 变更类型

  • 🐛 Bug fix | 修复 Bug（不影响现有功能的修复）
  • ✨ New feature | 新功能（不影响现有功能的新增）
  • 💥 Breaking change | 破坏性变更（会导致现有功能无法正常工作的修复或功能）
  • 📝 Documentation update | 文档更新
  • 🎨 Code style update | 代码样式更新（格式化、重命名等）
  • ♻️ Refactoring | 重构（无功能变更）
  • ⚡ Performance improvement | 性能优化
  • ✅ Test update | 测试更新
  • 🔧 Build/config change | 构建/配置变更
  • 🔒 Security fix | 安全修复

🔗 Related Issues | 相关 Issue

  • Closes # | 关闭 #
  • Related to # | 相关 #

📋 Changes Made | 具体变更

English:

  • Change 1
  • Change 2
  • Change 3

中文：

  • 变更 1
  • 变更 2
  • 变更 3

🧪 Testing | 测试

Manual Testing | 手动测试

  • Tested locally | 本地测试通过
  • Tested on testnet | 测试网测试通过（交易所集成相关）
  • Tested with different configurations | 测试了不同配置
  • Verified no existing functionality broke | 确认没有破坏现有功能

Test Environment | 测试环境

  • OS | 操作系统: [e.g. macOS, Ubuntu, Windows]
  • Go Version | Go 版本: [e.g. 1.21.5]
  • Node Version | Node 版本: [e.g. 18.x] (if applicable | 如适用)
  • Exchange | 交易所: [if applicable | 如适用]

Test Results | 测试结果

Test output here | 测试输出

📸 Screenshots / Demo | 截图/演示

Before | 变更前:

After | 变更后:

✅ Checklist | 检查清单

Code Quality | 代码质量

  • My code follows the project's code style | 我的代码遵循项目代码风格 (Contributing Guide)
  • 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 | 我的变更没有产生新的警告或错误
  • Code compiles successfully | 代码编译成功 (go build / npm run build)
  • I have run go fmt (for Go code) | 我已运行 go fmt（Go 代码）
  • I have run npm run lint (for frontend code) | 我已运行 npm run lint（前端代码）

Testing | 测试

  • I have added tests that prove my fix is effective or that my feature works | 我已添加证明修复有效或功能正常的测试
  • New and existing unit tests pass locally | 新旧单元测试在本地通过
  • I have tested on testnet (for trading/exchange changes) | 我已在测试网测试（交易/交易所变更）
  • Integration tests pass | 集成测试通过

Documentation | 文档

  • I have updated the documentation accordingly | 我已相应更新文档
  • I have updated the README if needed | 我已更新 README（如需要）
  • I have added inline code comments where necessary | 我已在必要处添加代码注释
  • I have updated type definitions (for TypeScript changes) | 我已更新类型定义（TypeScript 变更）
  • I have updated API documentation (if applicable) | 我已更新 API 文档（如适用）

Git

  • My commits follow the conventional commits format | 我的提交遵循 Conventional Commits 格式 (feat:, fix:, etc.)
  • I have rebased my branch on the latest dev branch | 我已将分支 rebase 到最新的 dev 分支
  • There are no merge conflicts | 没有合并冲突
  • Commit messages are clear and descriptive | 提交信息清晰明确

🔒 Security Considerations | 安全考虑

  • No API keys or secrets are hardcoded | 没有硬编码 API 密钥或密钥
  • User inputs are properly validated | 用户输入已正确验证
  • No SQL injection vulnerabilities introduced | 未引入 SQL 注入漏洞
  • No XSS vulnerabilities introduced | 未引入 XSS 漏洞
  • Authentication/authorization properly handled | 认证/授权已正确处理
  • Sensitive data is encrypted | 敏感数据已加密
  • N/A (not security-related) | 不适用（非安全相关）

⚡ Performance Impact | 性能影响

  • No significant performance impact | 无显著性能影响
  • Performance improved | 性能提升
  • Performance may be impacted (explain below) | 性能可能受影响（请在下方说明）

English:

中文：

🌐 Internationalization | 国际化

  • All user-facing text supports i18n | 所有面向用户的文本支持国际化
  • Both English and Chinese versions provided | 提供了中英文版本
  • N/A | 不适用

📚 Additional Notes | 补充说明

English:

中文：

💰 For Bounty Claims | 赏金申请

  • This PR is for bounty issue # | 此 PR 用于赏金 issue #
  • All acceptance criteria from the bounty issue are met | 满足赏金 issue 的所有验收标准
  • I have included a demo video/screenshots | 我已包含演示视频/截图
  • I am ready for payment upon merge | 我准备好在合并后接收付款

Payment Details | 付款详情:

🙏 Reviewer Notes | 审查者注意事项

English:

中文：

📋 PR Size Estimate | PR 大小估计

  • 🟢 Small (< 100 lines) | 小（< 100 行）
  • 🟡 Medium (100-500 lines) | 中（100-500 行）
  • 🔴 Large (> 500 lines) | 大（> 500 行）

🎯 Review Focus Areas | 审查重点

Please pay special attention to: 请特别注意：

  • Logic changes | 逻辑变更
  • Security implications | 安全影响
  • Performance optimization | 性能优化
  • API changes | API 变更
  • Database schema changes | 数据库架构变更
  • UI/UX changes | UI/UX 变更

By submitting this PR, I confirm that: 提交此 PR，我确认：

  • I have read the Contributing Guidelines | 我已阅读贡献指南
  • I agree to the Code of Conduct | 我同意行为准则
  • My contribution is licensed under the AGPL-3.0 License | 我的贡献遵循 AGPL-3.0 许可证
  • I understand this is a voluntary contribution | 我理解这是自愿贡献
  • I have the right to submit this code | 我有权提交此代码
Reference in New Issue View Git Blame Copy Permalink