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

docs: update PR templates to English-only (#1332)

Browse Source
This commit is contained in:
SkywalkerJi
2026-01-12 22:50:03 -06:00
committed by GitHub
parent b10b9ec1a7
commit 502801777f
2 changed files with 169 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/PR_TITLE_GUIDE.md
+121 -121
View File
@@ -1,16 +1,16 @@
# PR 标题指南
# PR Title Guide
## 📋 概述
## 📋 Overview
我们使用 **Conventional Commits** 格式来保持 PR 标题的一致性，但这是**建议性的**，不会阻止你的 PR 被合并。
We use the **Conventional Commits** format to maintain consistency in PR titles, but this is **recommended**, not mandatory. It will not prevent your PR from being merged.
## ✅ 推荐格式
## ✅ Recommended Format
```
type(scope): description
```
### 示例
### Examples
```
feat(trader): add new trading strategy
@@ -22,63 +22,63 @@ ci(workflow): improve GitHub Actions
---
## 📖 详细说明
## 📖 Detailed Guide
### Type（类型）- 必需
### Type - Required
描述这次变更的类型：
Describes the type of change:
| Type | 说明 | 示例 |
|------|------|------|
| `feat` | 新功能 | `feat(trader): add stop-loss feature` |
| `fix` | Bug 修复 | `fix(api): handle null response` |
| `docs` | 文档变更 | `docs: update installation guide` |
| `style` | 代码格式（不影响代码运行） | `style: format code with prettier` |
| `refactor` | 重构（既不是新功能也不是修复） | `refactor(exchange): simplify connection logic` |
| `perf` | 性能优化 | `perf(ai): optimize prompt processing` |
| `test` | 添加或修改测试 | `test(trader): add unit tests` |
| `chore` | 构建过程或辅助工具的变动 | `chore: update dependencies` |
| `ci` | CI/CD 相关变更 | `ci: add test coverage report` |
| `security` | 安全相关修复 | `security: update vulnerable dependencies` |
| `build` | 构建系统或外部依赖项变更 | `build: upgrade webpack to v5` |
| Type | Description | Example |
|------|-------------|---------|
| `feat` | New feature | `feat(trader): add stop-loss feature` |
| `fix` | Bug fix | `fix(api): handle null response` |
| `docs` | Documentation change | `docs: update installation guide` |
| `style` | Code formatting (no functional change) | `style: format code with prettier` |
| `refactor` | Code refactoring (neither feature nor fix) | `refactor(exchange): simplify connection logic` |
| `perf` | Performance optimization | `perf(ai): optimize prompt processing` |
| `test` | Add or modify tests | `test(trader): add unit tests` |
| `chore` | Build process or auxiliary tool changes | `chore: update dependencies` |
| `ci` | CI/CD related changes | `ci: add test coverage report` |
| `security` | Security fixes | `security: update vulnerable dependencies` |
| `build` | Build system or external dependency changes | `build: upgrade webpack to v5` |
### Scope（范围）- 可选
### Scope - Optional
描述这次变更影响的范围：
Describes the area affected by the change:
| Scope | 说明 |
|-------|------|
| `exchange` | 交易所相关 |
| `trader` | 交易员/交易策略 |
| `ai` | AI 模型相关 |
| `api` | API 接口 |
| `ui` | 用户界面 |
| `frontend` | 前端代码 |
| `backend` | 后端代码 |
| `security` | 安全相关 |
| `deps` | 依赖项 |
| Scope | Description |
|-------|-------------|
| `exchange` | Exchange-related |
| `trader` | Trader/trading strategy |
| `ai` | AI model related |
| `api` | API interface |
| `ui` | User interface |
| `frontend` | Frontend code |
| `backend` | Backend code |
| `security` | Security related |
| `deps` | Dependencies |
| `workflow` | GitHub Actions workflows |
| `github` | GitHub 配置 |
| `github` | GitHub configuration |
| `actions` | GitHub Actions |
| `config` | 配置文件 |
| `docker` | Docker 相关 |
| `build` | 构建相关 |
| `release` | 发布相关 |
| `config` | Configuration files |
| `docker` | Docker related |
| `build` | Build related |
| `release` | Release related |
**注意：** 如果变更影响多个范围，可以省略 scope 或选择最主要的。
**Note:** If the change affects multiple scopes, you can omit the scope or choose the most relevant one.
### Description（描述）- 必需
### Description - Required
- 使用现在时态（"add" 而不是 "added"）
- 首字母小写
- 结尾不加句号
- 简洁明了地描述变更内容
- Use present tense ("add" not "added")
- Start with lowercase
- No period at the end
- Concisely describe what changed
---
## 🎯 完整示例
## 🎯 Complete Examples
### ✅ 好的 PR 标题
### ✅ Good PR Titles
```
feat(trader): add risk management system
@@ -94,38 +94,38 @@ security(api): fix SQL injection vulnerability
build(docker): optimize Docker image size
```
### ⚠️ 需要改进的标题
### ⚠️ Titles That Need Improvement
| 不好的标题 | 问题 | 改进后 |
|-----------|------|--------|
| `update code` | 太模糊 | `refactor(trader): simplify order execution logic` |
| `Fixed bug` | 首字母大写，不够具体 | `fix(api): handle edge case in login` |
| `Add new feature.` | 有句号，不够具体 | `feat(ui): add dark mode toggle` |
| `changes` | 完全不符合格式 | `chore: update dependencies` |
| `feat: Added new trading algo` | 时态错误 | `feat(trader): add new trading algorithm` |
| Poor Title | Issue | Improved |
|-----------|-------|----------|
| `update code` | Too vague | `refactor(trader): simplify order execution logic` |
| `Fixed bug` | Capitalized, not specific | `fix(api): handle edge case in login` |
| `Add new feature.` | Has period, not specific | `feat(ui): add dark mode toggle` |
| `changes` | Doesn't follow format | `chore: update dependencies` |
| `feat: Added new trading algo` | Wrong tense | `feat(trader): add new trading algorithm` |
---
## 🤖 自动检查行为
## 🤖 Automated Check Behavior
### 当 PR 标题不符合格式时
### When PR Title Doesn't Follow Format
1. **不会阻止合并** ✅
- 检查会标记为"建议"
- PR 仍然可以被审查和合并
1. **Won't block merging** ✅
- Check is marked as "advisory"
- PR can still be reviewed and merged
2. **会收到友好提示** 💬
- 机器人会在 PR 中留言
- 提供格式说明和示例
- 建议如何改进标题
2. **Provides friendly reminder** 💬
- Bot will comment on the PR
- Provides format guidance and examples
- Suggests how to improve the title
3. **可以随时更新** 🔄
- 更新 PR 标题后会重新检查
- 无需关闭和重新打开 PR
3. **Can be updated anytime** 🔄
- Re-checks after updating PR title
- No need to close and reopen PR
### 示例评论
### Example Comment
如果你的 PR 标题是 `update workflow`，你会收到这样的评论：
If your PR title is `update workflow`, you'll receive a comment like this:
```markdown
## ⚠️ PR Title Format Suggestion
@@ -157,11 +157,11 @@ Your PR can still be reviewed and merged.
---
## 🔧 配置详情
## 🔧 Configuration Details
### 支持的 Types
### Supported Types
在 `.github/workflows/pr-checks.yml` 中配置：
Configured in `.github/workflows/pr-checks.yml`:
```yaml
types: |
@@ -178,7 +178,7 @@ types: |
build
```
### 支持的 Scopes
### Supported Scopes
```yaml
scopes: |
@@ -200,38 +200,38 @@ scopes: |
release
```
### 添加新的 Scope
### Adding New Scopes
如果你需要添加新的 scope，请：
If you need to add a new scope:
1. 在 `.github/workflows/pr-checks.yml` 的 `scopes` 部分添加
2. 在 `.github/workflows/pr-checks-run.yml` 更新正则表达式（可选）
3. 更新本文档
1. Add it to the `scopes` section in `.github/workflows/pr-checks.yml`
2. Update the regex in `.github/workflows/pr-checks-run.yml` (optional)
3. Update this documentation
---
## 📚 为什么使用 Conventional Commits？
## 📚 Why Use Conventional Commits?
### 优点
### Benefits
1. **自动化 Changelog** 📝
- 可以自动生成版本更新日志
- 清晰地分类各种变更
1. **Automated Changelog** 📝
- Automatically generate version changelogs
- Clearly categorize different types of changes
2. **语义化版本** 🔢
- `feat` → MINOR 版本（1.1.0）
- `fix` → PATCH 版本（1.0.1）
- `BREAKING CHANGE` → MAJOR 版本（2.0.0）
2. **Semantic Versioning** 🔢
- `feat` → MINOR version (1.1.0)
- `fix` → PATCH version (1.0.1)
- `BREAKING CHANGE` → MAJOR version (2.0.0)
3. **更好的可读性** 👀
- 一眼看出 PR 的目的
- 更容易浏览 Git 历史
3. **Better Readability** 👀
- Understand PR purpose at a glance
- Easier to browse Git history
4. **团队协作** 🤝
- 统一的提交风格
- 降低沟通成本
4. **Team Collaboration** 🤝
- Unified commit style
- Reduces communication overhead
### 示例：自动生成的 Changelog
### Example: Auto-generated Changelog
```markdown
## v1.2.0 (2025-11-02)
@@ -250,9 +250,9 @@ scopes: |
---
## 🎓 学习资源
## 🎓 Learning Resources
- **Conventional Commits 官网:** https://www.conventionalcommits.org/
- **Conventional Commits:** https://www.conventionalcommits.org/
- **Angular Commit Guidelines:** https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit
- **Semantic Versioning:** https://semver.org/
@@ -260,33 +260,33 @@ scopes: |
## ❓ FAQ
### Q: 我必须遵循这个格式吗？
### Q: Must I follow this format?
**A:** 不必须。这是建议性的，不会阻止你的 PR 被合并。但遵循格式可以提高项目的可维护性。
**A:** No. This is recommended but not mandatory. It won't block your PR from being merged. However, following the format improves project maintainability.
### Q: 如果我忘记了怎么办？
### Q: What if I forget?
**A:** 机器人会在 PR 中提醒你，你可以随时更新标题。
**A:** The bot will remind you in the PR comments. You can update the title anytime.
### Q: 我可以在一个 PR 中做多种类型的变更吗？
### Q: Can I make multiple types of changes in one PR?
**A:** 可以，但建议：
- 选择最主要的类型
- 或者考虑拆分成多个 PR（更易于审查）
**A:** Yes, but it's recommended to:
- Choose the most significant type
- Or consider splitting into multiple PRs (easier to review)
### Q: Scope 可以省略吗？
### Q: Can I omit the scope?
**A:** 可以。`requireScope: false` 表示 scope 是可选的。
**A:** Yes. `requireScope: false` means scope is optional.
示例：`docs: update README` （没有 scope 也可以）
Example: `docs: update README` (no scope is fine)
### Q: 我想添加新的 type 或 scope，怎么做？
### Q: How do I add a new type or scope?
**A:** 提一个 PR 修改 `.github/workflows/pr-checks.yml`，并在本文档中说明新增项的用途。
**A:** Submit a PR to modify `.github/workflows/pr-checks.yml` and document the purpose of the new item in this guide.
### Q: Breaking Changes 怎么表示？
### Q: How do I indicate Breaking Changes?
**A:** 在描述中添加 `BREAKING CHANGE:` 或在 type 后加 `!`：
**A:** Add `BREAKING CHANGE:` in the description or add `!` after the type:
```
feat!: remove deprecated API
@@ -297,9 +297,9 @@ BREAKING CHANGE: The old /auth endpoint is removed
---
## 📊 统计
## 📊 Statistics
想看项目的 commit 类型分布？运行：
Want to see the commit type distribution in your project? Run:
```bash
git log --oneline --no-merges | \
@@ -309,14 +309,14 @@ git log --oneline --no-merges | \
---
## ✅ 快速检查清单
## ✅ Quick Checklist
在提交 PR 前，检查你的标题是否：
Before submitting a PR, check if your title:
- [ ] 包含有效的 type（feat, fix, docs 等）
- [ ] 使用小写字母开头
- [ ] 使用现在时态（"add" 而不是 "added"）
- [ ] 简洁明了（最好在 50 字符内）
- [ ] 准确描述了变更内容
- [ ] Contains a valid type (feat, fix, docs, etc.)
- [ ] Starts with lowercase
- [ ] Uses present tense ("add" not "added")
- [ ] Is concise (preferably under 50 characters)
- [ ] Accurately describes the change
**记住：** 这些都是建议，不是强制要求！
**Remember:** These are recommendations, not requirements!
.github/PULL_REQUEST_TEMPLATE.md
+48 -52
View File
@@ -1,104 +1,100 @@
# Pull Request | PR 提交
# Pull Request
> **📋 选择专用模板 | Choose Specialized Template**
> **📋 Choose Specialized Template**
>
> 我们现在提供了针对不同类型PR的专用模板，帮助你更快速地填写PR信息：
> We now offer specialized templates for different types of PRs to help you fill out the information faster:
>
> - 🔧 **[Backend PR Template](./PULL_REQUEST_TEMPLATE/backend.md)** | 后端PR模板 - For Go/API/Trading changes
> - 🎨 **[Frontend PR Template](./PULL_REQUEST_TEMPLATE/frontend.md)** | 前端PR模板 - For UI/UX changes
> - 📝 **[Documentation PR Template](./PULL_REQUEST_TEMPLATE/docs.md)** | 文档PR模板 - For documentation updates
> - 📦 **[General PR Template](./PULL_REQUEST_TEMPLATE/general.md)** | 通用PR模板 - For mixed or other changes
> - 🔧 **[Backend PR Template](./PULL_REQUEST_TEMPLATE/backend.md)** - For Go/API/Trading changes
> - 🎨 **[Frontend PR Template](./PULL_REQUEST_TEMPLATE/frontend.md)** - For UI/UX changes
> - 📝 **[Documentation PR Template](./PULL_REQUEST_TEMPLATE/docs.md)** - For documentation updates
> - 📦 **[General PR Template](./PULL_REQUEST_TEMPLATE/general.md)** - For mixed or other changes
>
> **如何使用？| How to use?**
> - 创建PR时，在URL中添加 `?template=backend.md` 或其他模板名称
> **How to use?**
> - When creating a PR, add `?template=backend.md` or other template name to the URL
> - 或者直接复制粘贴对应模板的内容
> - Or simply copy and paste the content from the corresponding template
---
> **💡 提示 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
<!-- Describe your changes in detail -->
---
## 🎯 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:** ｜ **中文：**
<!-- List the specific changes made -->
-
-
---
## 🧪 Testing | 测试
## 🧪 Testing
- [ ] Tested locally | 本地测试通过
- [ ] Tests pass | 测试通过
- [ ] Verified no existing functionality broke | 确认没有破坏现有功能
- [ ] Tested locally
- [ ] Tests pass
- [ ] Verified no existing functionality broke
---
## ✅ Checklist | 检查清单
## ✅ Checklist
### Code Quality | 代码质量
- [ ] Code follows project style | 代码遵循项目风格
- [ ] Self-review completed | 已完成代码自查
- [ ] Comments added for complex logic | 已添加必要注释
### Code Quality
- [ ] Code follows project style
- [ ] Self-review completed
- [ ] Comments added for complex logic
### Documentation | 文档
- [ ] Updated relevant documentation | 已更新相关文档
### Documentation
- [ ] Updated relevant documentation
### 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 | 补充说明
## 📚 Additional Notes
**English:** ｜ **中文：**
<!-- Any additional information or context -->
---
**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!**