Skip to content

Commit 78bf353

Browse files
authored
Fix/docs (#24)
* chore: quick update fix/docs at 2026-03-14 14:35:55 * chore: quick update fix/docs at 2026-03-14 14:49:44
1 parent 2d67750 commit 78bf353

10 files changed

Lines changed: 996 additions & 2513 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 45 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,63 @@
1-
## Description / 描述
1+
## 变更说明
22

3-
<!-- Briefly describe what this PR does / 简要描述此 PR 的内容 -->
3+
<!-- 简要说明本次变更内容 -->
44

5-
## Type of Change / 变更类型
5+
## 变更类型
66

7-
- [ ] 🐛 Bug fix / 缺陷修复
8-
- [ ] ✨ New feature / 新功能
9-
- [ ] 💥 Breaking change / 破坏性变更
10-
- [ ] 📝 Documentation / 文档更新
11-
- [ ] 🔧 Configuration / 配置变更
12-
- [ ] ♻️ Refactor / 代码重构
13-
- [ ] 🎨 Style / 代码风格
14-
- [ ] ⚡ Performance / 性能优化
15-
- [ ] ✅ Test / 测试相关
7+
- [ ] 缺陷修复
8+
- [ ] 新功能
9+
- [ ] 破坏性变更
10+
- [ ] 文档更新
11+
- [ ] 配置变更
12+
- [ ] 代码重构
13+
- [ ] 风格调整
14+
- [ ] 性能优化
15+
- [ ] 测试相关
1616

17-
## Related Issues / 关联 Issue
17+
## 关联问题
1818

19-
<!-- Link related issues: Fixes #123, Closes #456 -->
20-
<!-- 关联相关 Issue:Fixes #123, Closes #456 -->
19+
<!-- 填写关联问题编号,例如:修复 #123 -->
2120

22-
## Pre-submission Checklist / 提交前检查清单
21+
## 提交前检查清单
2322

24-
### Critical Issues / 关键问题 🔴
25-
- [ ] No requirements mismatch `[REQ]` / 无需求不匹配
26-
- [ ] No logic bugs `[LOGI]` / 无逻辑缺陷
27-
- [ ] No security vulnerabilities `[SEC]` / 无安全漏洞
28-
- [ ] No auth/permission issues `[AUTH]` / 无认证授权问题
23+
### 关键项
24+
- [ ] 无需求不匹配问题(`REQ`
25+
- [ ] 无逻辑缺陷(`LOGI`
26+
- [ ] 无安全问题(`SEC`
27+
- [ ] 无认证授权问题(`AUTH`
2928

30-
### High Priority / 高优先级 🟠
31-
- [ ] Design is appropriate `[DSN]` / 设计合理
32-
- [ ] Error handling is robust `[RBST]` / 错误处理健壮
33-
- [ ] Transactions handled correctly `[TRANS]` / 事务处理正确
34-
- [ ] No concurrency issues `[CONC]` / 无并发问题
35-
- [ ] Performance is acceptable `[PERF]` / 性能可接受
29+
### 高优先级项
30+
- [ ] 设计合理(`DSN`
31+
- [ ] 错误处理健壮(`RBST`
32+
- [ ] 事务处理正确(`TRANS`
33+
- [ ] 无并发问题(`CONC`
34+
- [ ] 性能可接受(`PERF`
3635

37-
### Code Quality / 代码质量 🟡🟢
38-
- [ ] Code is maintainable `[MAIN]` / 代码可维护
39-
- [ ] No unnecessary coupling `[CPL]` / 无不必要耦合
40-
- [ ] Code is readable `[READ]` / 代码可读
41-
- [ ] No code duplication `[DUP]` / 无代码重复
42-
- [ ] Naming is clear `[NAM]` / 命名清晰
36+
### 质量项
37+
- [ ] 代码可维护(`MAIN`
38+
- [ ] 无不必要耦合(`CPL`
39+
- [ ] 代码可读(`READ`
40+
- [ ] 无重复代码(`DUP`
41+
- [ ] 命名清晰(`NAM`
4342

44-
### Testing / 测试
45-
- [ ] Unit tests added/updated / 已添加/更新单元测试
46-
- [ ] Integration tests passed / 集成测试通过
47-
- [ ] Manual testing completed / 已完成手动测试
43+
### 测试项
44+
- [ ] 已补充或更新单元测试
45+
- [ ] 集成测试通过
46+
- [ ] 已完成手动验证
4847

49-
### Documentation / 文档
50-
- [ ] Code comments added where needed / 已添加必要的代码注释
51-
- [ ] README updated if needed / 如需要已更新 README
52-
- [ ] API docs updated if needed / 如需要已更新 API 文档
48+
### 文档项
49+
- [ ] 已补充必要注释
50+
- [ ] 如需已更新 README
51+
- [ ] 如需已更新相关文档
5352

54-
## Screenshots / 截图
53+
## 截图(如适用)
5554

56-
<!-- If applicable, add screenshots / 如适用,添加截图 -->
55+
<!-- 可选 -->
5756

58-
## Additional Notes / 补充说明
57+
## 补充说明
5958

60-
<!-- Any additional information for reviewers / 给审查者的其他信息 -->
59+
<!-- 可选 -->
6160

6261
---
6362

64-
> 💡 **Review Guidelines**: This PR will be reviewed following our [Code Review Guide / 代码审查指南](docs/codereview/CODE_REVIEW_GUIDE_CN.md)
63+
> 审查请参考:`.github/codereview/CODE_REVIEW_GUIDE_CN.md`

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
1. **简单、高效、安全的设计** - 避免过度设计;优先考虑清晰性和安全性
1818
2. **严格的完整性和性能** - 确保数据完整性,按需优化
1919
3. **合理的模块化** - 模块内高内聚,模块间低耦合
20-
4. **减少重复** - DRY原则
20+
4. **减少重复** - 不重复原则
2121
5. **良好的命名和注释** - 清晰、描述性的名称;有意义的注释
2222

2323
## 审查分类参考

0 commit comments

Comments
 (0)