diff --git a/.github/PULL_REQUEST_TEMPLATE/README.md b/.github/PULL_REQUEST_TEMPLATE/README.md index f0478ba7..a90d1ee1 100644 --- a/.github/PULL_REQUEST_TEMPLATE/README.md +++ b/.github/PULL_REQUEST_TEMPLATE/README.md @@ -1,213 +1,177 @@ -# PR Templates | PR 模板 +# PR Templates -## 📋 模板概述 | Template Overview +## 📋 Template Overview -我们提供了4种针对不同类型PR的专用模板，帮助贡献者快速填写PR信息： We offer 4 specialized templates for different types of PRs to help contributors quickly fill out PR information: -### 1. 🔧 Backend Template | 后端模板 -**文件:** `backend.md` +### 1. 🔧 Backend Template +**File:** `backend.md` -**适用于 | Use for:** -- Go代码变更 | Go code changes -- API端点开发 | API endpoint development -- 交易逻辑实现 | Trading logic implementation -- 后端性能优化 | Backend performance optimization -- 数据库相关改动 | Database-related changes +**Use for:** +- Go code changes +- API endpoint development +- Trading logic implementation +- Backend performance optimization +- Database-related changes -**包含 | Includes:** -- Go测试环境配置 | Go test environment -- 安全考虑检查 | Security considerations -- 性能影响评估 | Performance impact assessment -- `go fmt` 和 `go build` 检查 | `go fmt` and `go build` checks +**Includes:** +- Go test environment +- Security considerations +- Performance impact assessment +- `go fmt` and `go build` checks -### 2. 🎨 Frontend Template | 前端模板 -**文件:** `frontend.md` +### 2. 🎨 Frontend Template +**File:** `frontend.md` -**适用于 | Use for:** -- UI/UX变更 | UI/UX changes -- React/Vue组件开发 | React/Vue component development -- 前端样式更新 | Frontend styling updates -- 浏览器兼容性修复 | Browser compatibility fixes -- 前端性能优化 | Frontend performance optimization +**Use for:** +- UI/UX changes +- React/Vue component development +- Frontend styling updates +- Browser compatibility fixes +- Frontend performance optimization -**包含 | Includes:** -- 截图/演示要求 | Screenshots/demo requirements -- 浏览器测试清单 | Browser testing checklist -- 国际化检查 | Internationalization checks -- 响应式设计验证 | Responsive design verification -- `npm run lint` 和 `npm run build` 检查 | Linting and build checks +**Includes:** +- Screenshots/demo requirements +- Browser testing checklist +- Internationalization checks +- Responsive design verification +- `npm run lint` and `npm run build` checks -### 3. 📝 Documentation Template | 文档模板 -**文件:** `docs.md` +### 3. 📝 Documentation Template +**File:** `docs.md` -**适用于 | Use for:** -- README更新 | README updates -- API文档编写 | API documentation -- 教程和指南 | Tutorials and guides -- 代码注释改进 | Code comment improvements -- 翻译工作 | Translation work +**Use for:** +- README updates +- API documentation +- Tutorials and guides +- Code comment improvements +- Translation work -**包含 | Includes:** -- 文档类型分类 | Documentation type classification -- 内容质量检查 | Content quality checks -- 双语要求（中英文）| Bilingual requirements (EN/CN) -- 链接有效性验证 | Link validity verification +**Includes:** +- Documentation type classification +- Content quality checks +- Bilingual requirements (EN/CN) +- Link validity verification -### 4. 📦 General Template | 通用模板 -**文件:** `general.md` +### 4. 📦 General Template +**File:** `general.md` -**适用于 | Use for:** -- 混合类型变更 | Mixed-type changes -- 跨多个领域的PR | Cross-domain PRs -- 构建配置变更 | Build configuration changes -- 依赖更新 | Dependency updates -- 不确定使用哪个模板时 | When unsure which template to use +**Use for:** +- Mixed-type changes +- Cross-domain PRs +- Build configuration changes +- Dependency updates +- When unsure which template to use -## 🤖 自动模板建议 | Automatic Template Suggestion +## 🤖 Automatic Template Suggestion -我们的GitHub Action会自动分析你的PR并建议最合适的模板： Our GitHub Action automatically analyzes your PR and suggests the most suitable template: -### 工作原理 | How it works: +### How it works: -1. **文件分析 | File Analysis** - - 检测PR中所有变更的文件类型 +1. **File Analysis** - Detects all changed file types in the PR -2. **智能判断 | Smart Detection** - - 如果 >50% 是 `.go` 文件 → 建议**后端模板** +2. **Smart Detection** - If >50% are `.go` files → Suggests **Backend template** - - 如果 >50% 是 `.js/.ts/.tsx/.vue` 文件 → 建议**前端模板** - If >50% are `.js/.ts/.tsx/.vue` files → Suggests **Frontend template** - - 如果 >70% 是 `.md` 文件 → 建议**文档模板** - If >70% are `.md` files → Suggests **Documentation template** -3. **自动评论 | Auto-comment** - - 如果检测到你使用了默认模板，但应该用专用模板 +3. **Auto-comment** - If it detects you're using the default template but should use a specialized one - - 会自动添加友好的评论建议 - It will automatically add a friendly comment suggestion -4. **自动标签 | Auto-labeling** - - 自动添加对应的标签：`backend`、`frontend`、`documentation` +4. **Auto-labeling** - Automatically adds corresponding labels: `backend`, `frontend`, `documentation` -## 📖 使用方法 | How to Use +## 📖 How to Use -### 方法1: URL参数（推荐） | Method 1: URL Parameter (Recommended) +### Method 1: URL Parameter (Recommended) -创建PR时，在URL末尾添加模板参数： When creating a PR, add the template parameter to the URL: ``` https://github.com/YOUR_ORG/nofx/compare/dev...YOUR_BRANCH?template=backend.md ``` -替换 `backend.md` 为： Replace `backend.md` with: -- `backend.md` - 后端模板 | Backend template -- `frontend.md` - 前端模板 | Frontend template -- `docs.md` - 文档模板 | Documentation template -- `general.md` - 通用模板 | General template +- `backend.md` - Backend template +- `frontend.md` - Frontend template +- `docs.md` - Documentation template +- `general.md` - General template -### 方法2: 手动选择 | Method 2: Manual Selection +### Method 2: Manual Selection -1. 创建PR时，默认模板会显示 - When creating a PR, the default template will be shown +1. When creating a PR, the default template will be shown -2. 根据顶部的指引链接，点击查看对应的模板 - Follow the guidance links at the top to view the corresponding template +2. Follow the guidance links at the top to view the corresponding template -3. 复制模板内容到PR描述中 - Copy the template content into the PR description +3. Copy the template content into the PR description -### 方法3: 跟随自动建议 | Method 3: Follow Auto-suggestion +### Method 3: Follow Auto-suggestion -1. 使用任何模板创建PR - Create a PR with any template +1. Create a PR with any template -2. GitHub Action会自动分析并评论建议 - GitHub Action will automatically analyze and comment with a suggestion +2. GitHub Action will automatically analyze and comment with a suggestion -3. 根据建议更新PR描述 - Update the PR description based on the suggestion +3. Update the PR description based on the suggestion -## 🎯 最佳实践 | Best Practices +## 🎯 Best Practices -1. **提前选择 | Choose in Advance** - - 在创建PR前确定变更类型 +1. **Choose in Advance** - Determine the change type before creating the PR -2. **完整填写 | Complete Filling** - - 不要跳过必填项（标记为 required） +2. **Complete Filling** - Don't skip required items -3. **保持简洁 | Keep it Concise** - - 描述清晰但简洁 +3. **Keep it Concise** - Keep descriptions clear but concise -4. **添加截图 | Add Screenshots** - - 对于UI变更，务必添加截图 +4. **Add Screenshots** - For UI changes, always add screenshots -5. **测试证明 | Test Evidence** - - 提供测试通过的证据 +5. **Test Evidence** - Provide evidence that tests pass -## 🔧 自定义 | Customization +## 🔧 Customization -如果需要修改模板或自动检测逻辑： If you need to modify templates or auto-detection logic: -1. **修改模板** | **Modify Templates** - - 编辑 `.github/PULL_REQUEST_TEMPLATE/*.md` 文件 +1. **Modify Templates** - Edit `.github/PULL_REQUEST_TEMPLATE/*.md` files -2. **调整检测阈值** | **Adjust Detection Threshold** - - 编辑 `.github/workflows/pr-template-suggester.yml` +2. **Adjust Detection Threshold** - Edit `.github/workflows/pr-template-suggester.yml` - - 修改文件类型占比阈值（当前：50%后端，50%前端，70%文档） - Modify file type percentage thresholds (current: 50% backend, 50% frontend, 70% docs) -3. **添加新模板** | **Add New Template** - - 在 `PULL_REQUEST_TEMPLATE/` 目录创建新的 `.md` 文件 +3. **Add New Template** - Create a new `.md` file in the `PULL_REQUEST_TEMPLATE/` directory - - 更新工作流以支持新的文件类型检测 - Update the workflow to support new file type detection ## ❓ FAQ -**Q: 我的PR既有前端又有后端代码，用哪个模板？** **Q: My PR has both frontend and backend code, which template should I use?** -A: 使用**通用模板**（`general.md`），或选择主要变更类型的模板。 A: Use the **General template** (`general.md`), or choose the template for the primary change type. --- -**Q: 自动建议的模板不合适怎么办？** **Q: What if the automatically suggested template is not suitable?** -A: 你可以忽略建议，继续使用当前模板。自动建议仅供参考。 A: You can ignore the suggestion and continue using the current template. Auto-suggestions are for reference only. --- -**Q: 可以不使用任何模板吗？** **Q: Can I not use any template?** -A: 不推荐。模板帮助确保PR包含必要信息，加快审查速度。 A: Not recommended. Templates help ensure PRs contain necessary information and speed up reviews. --- -**Q: 如何禁用自动模板建议？** **Q: How to disable automatic template suggestions?** -A: 删除或禁用 `.github/workflows/pr-template-suggester.yml` 文件。 A: Delete or disable the `.github/workflows/pr-template-suggester.yml` file. --- -🌟 **感谢使用我们的PR模板系统！| Thank you for using our PR template system!** +🌟 **Thank you for using our PR template system!** diff --git a/.github/PULL_REQUEST_TEMPLATE/backend.md b/.github/PULL_REQUEST_TEMPLATE/backend.md index dfc354c3..2cd356bf 100644 --- a/.github/PULL_REQUEST_TEMPLATE/backend.md +++ b/.github/PULL_REQUEST_TEMPLATE/backend.md @@ -1,121 +1,116 @@ -# Pull Request - Backend | 后端 PR +# Pull Request - Backend -> **💡 提示 Tip:** 推荐 PR 标题格式 `type(scope): description` -> 例如: `feat(trader): add new strategy` | `fix(api): resolve auth issue` +> **💡 Tip:** Recommended PR title format `type(scope): description` +> Example: `feat(trader): add new strategy` | `fix(api): resolve auth issue` --- -## 📝 Description | 描述 - -**English:** ｜ **中文：** +## 📝 Description --- -## 🎯 Type of Change | 变更类型 +## 🎯 Type of Change -- [ ] 🐛 Bug fix | 修复 Bug -- [ ] ✨ New feature | 新功能 -- [ ] 💥 Breaking change | 破坏性变更 -- [ ] ♻️ Refactoring | 重构 -- [ ] ⚡ Performance improvement | 性能优化 -- [ ] 🔒 Security fix | 安全修复 -- [ ] 🔧 Build/config change | 构建/配置变更 +- [ ] 🐛 Bug fix +- [ ] ✨ New feature +- [ ] 💥 Breaking change +- [ ] ♻️ Refactoring +- [ ] ⚡ Performance improvement +- [ ] 🔒 Security fix +- [ ] 🔧 Build/config change --- -## 🔗 Related Issues | 相关 Issue +## 🔗 Related Issues -- Closes # | 关闭 # -- Related to # | 相关 # +- Closes # +- Related to # --- -## 📋 Changes Made | 具体变更 +## 📋 Changes Made -**English:** ｜ **中文：** - - --- -## 🧪 Testing | 测试 +## 🧪 Testing -### Test Environment | 测试环境 -- **OS | 操作系统:** -- **Go Version | Go 版本:** -- **Exchange | 交易所:** [if applicable | 如适用] +### Test Environment +- **OS:** +- **Go Version:** +- **Exchange:** [if applicable] -### Manual Testing | 手动测试 -- [ ] Tested locally | 本地测试通过 -- [ ] Tested on testnet | 测试网测试通过（交易所集成相关） -- [ ] Unit tests pass | 单元测试通过 -- [ ] Verified no existing functionality broke | 确认没有破坏现有功能 +### Manual Testing +- [ ] Tested locally +- [ ] Tested on testnet (for exchange integration) +- [ ] Unit tests pass +- [ ] Verified no existing functionality broke -### Test Results | 测试结果 +### Test Results ``` -Test output here | 测试输出 +Test output here ``` --- -## 🔒 Security Considerations | 安全考虑 +## 🔒 Security Considerations -- [ ] No API keys or secrets hardcoded | 没有硬编码 API 密钥 -- [ ] User inputs properly validated | 用户输入已正确验证 -- [ ] No SQL injection vulnerabilities | 无 SQL 注入漏洞 -- [ ] Authentication/authorization properly handled | 认证/授权正确处理 -- [ ] Sensitive data is encrypted | 敏感数据已加密 -- [ ] N/A (not security-related) | 不适用 +- [ ] No API keys or secrets hardcoded +- [ ] User inputs properly validated +- [ ] No SQL injection vulnerabilities +- [ ] Authentication/authorization properly handled +- [ ] Sensitive data is encrypted +- [ ] N/A (not security-related) --- -## ⚡ Performance Impact | 性能影响 +## ⚡ Performance Impact -- [ ] No significant performance impact | 无显著性能影响 -- [ ] Performance improved | 性能提升 -- [ ] Performance may be impacted (explain below) | 性能可能受影响 +- [ ] No significant performance impact +- [ ] Performance improved +- [ ] Performance may be impacted (explain below) -**If impacted, explain | 如果受影响，请说明：** +**If impacted, explain:** --- -## ✅ Checklist | 检查清单 +## ✅ Checklist -### Code Quality | 代码质量 -- [ ] Code follows project style | 代码遵循项目风格 -- [ ] Self-review completed | 已完成代码自查 -- [ ] Comments added for complex logic | 已添加必要注释 -- [ ] Code compiles successfully | 代码编译成功 (`go build`) -- [ ] Ran `go fmt` | 已运行 `go fmt` +### Code Quality +- [ ] Code follows project style +- [ ] Self-review completed +- [ ] Comments added for complex logic +- [ ] Code compiles successfully (`go build`) +- [ ] Ran `go fmt` -### Documentation | 文档 -- [ ] Updated relevant documentation | 已更新相关文档 -- [ ] Added inline comments where necessary | 已添加必要的代码注释 -- [ ] Updated API documentation (if applicable) | 已更新 API 文档 +### Documentation +- [ ] Updated relevant documentation +- [ ] Added inline comments where necessary +- [ ] Updated API documentation (if applicable) ### Git -- [ ] Commits follow conventional format | 提交遵循 Conventional Commits 格式 -- [ ] Rebased on latest `dev` branch | 已 rebase 到最新 `dev` 分支 -- [ ] No merge conflicts | 无合并冲突 +- [ ] Commits follow conventional format +- [ ] Rebased on latest `dev` branch +- [ ] No merge conflicts --- -## 📚 Additional Notes | 补充说明 - -**English:** ｜ **中文：** +## 📚 Additional Notes --- -**By submitting this PR, I confirm | 提交此 PR，我确认：** +**By submitting this PR, I confirm:** -- [ ] I have read the [Contributing Guidelines](../../CONTRIBUTING.md) | 已阅读贡献指南 -- [ ] I agree to the [Code of Conduct](../../CODE_OF_CONDUCT.md) | 同意行为准则 -- [ ] My contribution is licensed under AGPL-3.0 | 贡献遵循 AGPL-3.0 许可证 +- [ ] I have read the [Contributing Guidelines](../../CONTRIBUTING.md) +- [ ] I agree to the [Code of Conduct](../../CODE_OF_CONDUCT.md) +- [ ] My contribution is licensed under AGPL-3.0 --- -🌟 **Thank you for your contribution! | 感谢你的贡献！** +🌟 **Thank you for your contribution!** diff --git a/.github/PULL_REQUEST_TEMPLATE/docs.md b/.github/PULL_REQUEST_TEMPLATE/docs.md index 2ce9a90c..110530b6 100644 --- a/.github/PULL_REQUEST_TEMPLATE/docs.md +++ b/.github/PULL_REQUEST_TEMPLATE/docs.md @@ -1,97 +1,91 @@ -# Pull Request - Documentation | 文档 PR +# Pull Request - Documentation -> **💡 提示 Tip:** 推荐 PR 标题格式 `docs(scope): description` -> 例如: `docs(api): update trading endpoints` | `docs(readme): add setup guide` +> **💡 Tip:** Recommended PR title format `docs(scope): description` +> Example: `docs(api): update trading endpoints` | `docs(readme): add setup guide` --- -## 📝 Description | 描述 - -**English:** ｜ **中文：** +## 📝 Description --- -## 📚 Type of Documentation | 文档类型 +## 📚 Type of Documentation -- [ ] 📖 README update | README 更新 -- [ ] 📋 API documentation | API 文档 -- [ ] 🎓 Tutorial/Guide | 教程/指南 -- [ ] 📝 Code comments | 代码注释 -- [ ] 🔧 Configuration docs | 配置文档 -- [ ] 🐛 Fix typo/error | 修复拼写/错误 -- [ ] 🌍 Translation | 翻译 +- [ ] 📖 README update +- [ ] 📋 API documentation +- [ ] 🎓 Tutorial/Guide +- [ ] 📝 Code comments +- [ ] 🔧 Configuration docs +- [ ] 🐛 Fix typo/error +- [ ] 🌍 Translation --- -## 🔗 Related Issues | 相关 Issue +## 🔗 Related Issues -- Closes # | 关闭 # -- Related to # | 相关 # +- Closes # +- Related to # --- -## 📋 Changes Made | 具体变更 +## 📋 Changes Made -**English:** ｜ **中文：** - - --- -## 📸 Screenshots (if applicable) | 截图（如适用） +## 📸 Screenshots (if applicable) - --- -## 🌐 Internationalization | 国际化 +## 🌐 Internationalization -- [ ] English version complete | 英文版本完整 -- [ ] Chinese version complete | 中文版本完整 -- [ ] Both versions are consistent | 两个版本内容一致 -- [ ] N/A (only one language needed) | 不适用（只需要一种语言） +- [ ] English version complete +- [ ] Chinese version complete +- [ ] Both versions are consistent +- [ ] N/A (only one language needed) --- -## ✅ Checklist | 检查清单 +## ✅ Checklist -### Content Quality | 内容质量 -- [ ] Information is accurate and up-to-date | 信息准确且最新 -- [ ] Language is clear and concise | 语言清晰简洁 -- [ ] No spelling or grammar errors | 无拼写或语法错误 -- [ ] Links are valid and working | 链接有效且可用 -- [ ] Code examples are tested and working | 代码示例已测试且可用 -- [ ] Formatting is consistent | 格式一致 +### Content Quality +- [ ] Information is accurate and up-to-date +- [ ] Language is clear and concise +- [ ] No spelling or grammar errors +- [ ] Links are valid and working +- [ ] Code examples are tested and working +- [ ] Formatting is consistent -### Documentation Standards | 文档标准 -- [ ] Follows project documentation style | 遵循项目文档风格 -- [ ] Includes necessary examples | 包含必要的示例 -- [ ] Technical terms are explained | 技术术语已解释 -- [ ] Self-review completed | 已完成自查 +### Documentation Standards +- [ ] Follows project documentation style +- [ ] Includes necessary examples +- [ ] Technical terms are explained +- [ ] Self-review completed ### Git -- [ ] Commits follow conventional format | 提交遵循 Conventional Commits 格式 -- [ ] Rebased on latest `dev` branch | 已 rebase 到最新 `dev` 分支 -- [ ] No merge conflicts | 无合并冲突 +- [ ] Commits follow conventional format +- [ ] Rebased on latest `dev` branch +- [ ] No merge conflicts --- -## 📚 Additional Notes | 补充说明 - -**English:** ｜ **中文：** +## 📚 Additional Notes --- -**By submitting this PR, I confirm | 提交此 PR，我确认：** +**By submitting this PR, I confirm:** -- [ ] I have read the [Contributing Guidelines](../../CONTRIBUTING.md) | 已阅读贡献指南 -- [ ] I agree to the [Code of Conduct](../../CODE_OF_CONDUCT.md) | 同意行为准则 -- [ ] My contribution is licensed under AGPL-3.0 | 贡献遵循 AGPL-3.0 许可证 +- [ ] I have read the [Contributing Guidelines](../../CONTRIBUTING.md) +- [ ] I agree to the [Code of Conduct](../../CODE_OF_CONDUCT.md) +- [ ] My contribution is licensed under AGPL-3.0 --- -🌟 **Thank you for your contribution! | 感谢你的贡献！** +🌟 **Thank you for your contribution!** diff --git a/.github/PULL_REQUEST_TEMPLATE/frontend.md b/.github/PULL_REQUEST_TEMPLATE/frontend.md index b95a20d0..cac6b788 100644 --- a/.github/PULL_REQUEST_TEMPLATE/frontend.md +++ b/.github/PULL_REQUEST_TEMPLATE/frontend.md @@ -1,119 +1,113 @@ -# Pull Request - Frontend | 前端 PR +# Pull Request - Frontend -> **💡 提示 Tip:** 推荐 PR 标题格式 `type(scope): description` -> 例如: `feat(ui): add dark mode toggle` | `fix(form): resolve validation bug` +> **💡 Tip:** Recommended PR title format `type(scope): description` +> Example: `feat(ui): add dark mode toggle` | `fix(form): resolve validation bug` --- -## 📝 Description | 描述 - -**English:** ｜ **中文：** +## 📝 Description --- -## 🎯 Type of Change | 变更类型 +## 🎯 Type of Change -- [ ] 🐛 Bug fix | 修复 Bug -- [ ] ✨ New feature | 新功能 -- [ ] 💥 Breaking change | 破坏性变更 -- [ ] 🎨 Code style update | 代码样式更新 -- [ ] ♻️ Refactoring | 重构 -- [ ] ⚡ Performance improvement | 性能优化 +- [ ] 🐛 Bug fix +- [ ] ✨ New feature +- [ ] 💥 Breaking change +- [ ] 🎨 Code style update +- [ ] ♻️ Refactoring +- [ ] ⚡ Performance improvement --- -## 🔗 Related Issues | 相关 Issue +## 🔗 Related Issues -- Closes # | 关闭 # -- Related to # | 相关 # +- Closes # +- Related to # --- -## 📋 Changes Made | 具体变更 +## 📋 Changes Made -**English:** ｜ **中文：** - - --- -## 📸 Screenshots / Demo | 截图/演示 +## 📸 Screenshots / Demo - -**Before | 变更前:** +**Before:** -**After | 变更后:** +**After:** --- -## 🧪 Testing | 测试 +## 🧪 Testing -### Test Environment | 测试环境 -- **OS | 操作系统:** -- **Node Version | Node 版本:** -- **Browser(s) | 浏览器:** +### Test Environment +- **OS:** +- **Node Version:** +- **Browser(s):** -### Manual Testing | 手动测试 -- [ ] Tested in development mode | 开发模式测试通过 -- [ ] Tested production build | 生产构建测试通过 -- [ ] Tested on multiple browsers | 多浏览器测试通过 -- [ ] Tested responsive design | 响应式设计测试通过 -- [ ] Verified no existing functionality broke | 确认没有破坏现有功能 +### Manual Testing +- [ ] Tested in development mode +- [ ] Tested production build +- [ ] Tested on multiple browsers +- [ ] Tested responsive design +- [ ] Verified no existing functionality broke --- -## 🌐 Internationalization | 国际化 +## 🌐 Internationalization -- [ ] All user-facing text supports i18n | 所有面向用户的文本支持国际化 -- [ ] Both English and Chinese versions provided | 提供了中英文版本 -- [ ] N/A | 不适用 +- [ ] All user-facing text supports i18n +- [ ] Both English and Chinese versions provided +- [ ] N/A --- -## ✅ Checklist | 检查清单 +## ✅ Checklist -### Code Quality | 代码质量 -- [ ] Code follows project style | 代码遵循项目风格 -- [ ] Self-review completed | 已完成代码自查 -- [ ] Comments added for complex logic | 已添加必要注释 -- [ ] Code builds successfully | 代码构建成功 (`npm run build`) -- [ ] Ran `npm run lint` | 已运行 `npm run lint` -- [ ] No console errors or warnings | 无控制台错误或警告 +### Code Quality +- [ ] Code follows project style +- [ ] Self-review completed +- [ ] Comments added for complex logic +- [ ] Code builds successfully (`npm run build`) +- [ ] Ran `npm run lint` +- [ ] No console errors or warnings -### Testing | 测试 -- [ ] Component tests added/updated | 已添加/更新组件测试 -- [ ] Tests pass locally | 测试在本地通过 +### Testing +- [ ] Component tests added/updated +- [ ] Tests pass locally -### Documentation | 文档 -- [ ] Updated relevant documentation | 已更新相关文档 -- [ ] Updated type definitions (TypeScript) | 已更新类型定义 -- [ ] Added JSDoc comments where necessary | 已添加 JSDoc 注释 +### Documentation +- [ ] Updated relevant documentation +- [ ] Updated type definitions (TypeScript) +- [ ] Added JSDoc comments where necessary ### Git -- [ ] Commits follow conventional format | 提交遵循 Conventional Commits 格式 -- [ ] Rebased on latest `dev` branch | 已 rebase 到最新 `dev` 分支 -- [ ] No merge conflicts | 无合并冲突 +- [ ] Commits follow conventional format +- [ ] Rebased on latest `dev` branch +- [ ] No merge conflicts --- -## 📚 Additional Notes | 补充说明 - -**English:** ｜ **中文：** +## 📚 Additional Notes --- -**By submitting this PR, I confirm | 提交此 PR，我确认：** +**By submitting this PR, I confirm:** -- [ ] I have read the [Contributing Guidelines](../../CONTRIBUTING.md) | 已阅读贡献指南 -- [ ] I agree to the [Code of Conduct](../../CODE_OF_CONDUCT.md) | 同意行为准则 -- [ ] My contribution is licensed under AGPL-3.0 | 贡献遵循 AGPL-3.0 许可证 +- [ ] I have read the [Contributing Guidelines](../../CONTRIBUTING.md) +- [ ] I agree to the [Code of Conduct](../../CODE_OF_CONDUCT.md) +- [ ] My contribution is licensed under AGPL-3.0 --- -🌟 **Thank you for your contribution! | 感谢你的贡献！** +🌟 **Thank you for your contribution!** diff --git a/.github/PULL_REQUEST_TEMPLATE/general.md b/.github/PULL_REQUEST_TEMPLATE/general.md index 23773e4c..21a1df8e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/general.md +++ b/.github/PULL_REQUEST_TEMPLATE/general.md @@ -1,98 +1,93 @@ -# Pull Request - General | 通用 PR +# Pull Request - General -> **💡 提示 Tip:** 推荐 PR 标题格式 `type(scope): description` -> 例如: `feat(trader): add new strategy` | `fix(api): resolve auth issue` | `docs(readme): update` +> **💡 Tip:** Recommended PR title format `type(scope): description` +> Example: `feat(trader): add new strategy` | `fix(api): resolve auth issue` | `docs(readme): update` --- -## 📝 Description | 描述 - -**English:** ｜ **中文：** +## 📝 Description --- -## 🎯 Type of Change | 变更类型 +## 🎯 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 | 安全修复 +- [ ] 🐛 Bug fix +- [ ] ✨ New feature +- [ ] 💥 Breaking change +- [ ] 📝 Documentation update +- [ ] 🎨 Code style update +- [ ] ♻️ Refactoring +- [ ] ⚡ Performance improvement +- [ ] ✅ Test update +- [ ] 🔧 Build/config change +- [ ] 🔒 Security fix --- -## 🔗 Related Issues | 相关 Issue +## 🔗 Related Issues -- Closes # | 关闭 # -- Related to # | 相关 # +- Closes # +- Related to # --- -## 📋 Changes Made | 具体变更 +## 📋 Changes Made -**English:** ｜ **中文：** - - --- -## 🧪 Testing | 测试 +## 🧪 Testing -- [ ] Tested locally | 本地测试通过 -- [ ] Tests pass | 测试通过 -- [ ] Verified no existing functionality broke | 确认没有破坏现有功能 +- [ ] Tested locally +- [ ] Tests pass +- [ ] Verified no existing functionality broke -**Test details | 测试详情：** +**Test details:** --- -## ✅ Checklist | 检查清单 +## ✅ Checklist -### Code Quality | 代码质量 -- [ ] Code follows project style | 代码遵循项目风格 -- [ ] Self-review completed | 已完成代码自查 -- [ ] Comments added for complex logic | 已添加必要注释 -- [ ] No new warnings or errors | 无新的警告或错误 +### Code Quality +- [ ] Code follows project style +- [ ] Self-review completed +- [ ] Comments added for complex logic +- [ ] No new warnings or errors -### Documentation | 文档 -- [ ] Updated relevant documentation | 已更新相关文档 -- [ ] Added inline comments where necessary | 已添加必要的代码注释 +### Documentation +- [ ] Updated relevant documentation +- [ ] Added inline comments where necessary ### Git -- [ ] Commits follow conventional format | 提交遵循 Conventional Commits 格式 -- [ ] Rebased on latest `dev` branch | 已 rebase 到最新 `dev` 分支 -- [ ] No merge conflicts | 无合并冲突 +- [ ] Commits follow conventional format +- [ ] Rebased on latest `dev` branch +- [ ] No merge conflicts --- -## 🔒 Security (if applicable) | 安全（如适用） +## 🔒 Security (if applicable) -- [ ] No API keys or secrets hardcoded | 没有硬编码 API 密钥 -- [ ] User inputs properly validated | 用户输入已正确验证 -- [ ] N/A | 不适用 +- [ ] No API keys or secrets hardcoded +- [ ] User inputs properly validated +- [ ] N/A --- -## 📚 Additional Notes | 补充说明 - -**English:** ｜ **中文：** +## 📚 Additional Notes --- -**By submitting this PR, I confirm | 提交此 PR，我确认：** +**By submitting this PR, I confirm:** -- [ ] I have read the [Contributing Guidelines](../../CONTRIBUTING.md) | 已阅读贡献指南 -- [ ] I agree to the [Code of Conduct](../../CODE_OF_CONDUCT.md) | 同意行为准则 -- [ ] My contribution is licensed under AGPL-3.0 | 贡献遵循 AGPL-3.0 许可证 +- [ ] I have read the [Contributing Guidelines](../../CONTRIBUTING.md) +- [ ] I agree to the [Code of Conduct](../../CODE_OF_CONDUCT.md) +- [ ] My contribution is licensed under AGPL-3.0 --- -🌟 **Thank you for your contribution! | 感谢你的贡献！** +🌟 **Thank you for your contribution!**