Simon
122 lines
2.2 KiB
Markdown
122 lines
2.2 KiB
Markdown
# Pull Request 模板
|
|
|
|
> **提交前必读**:
|
|
> - [ ] PR 标题用 [Conventional Commits](https://www.conventionalcommits.org/)(如 `feat:` / `fix:` / `docs:`)
|
|
> - [ ] 已关联 Issue(用 `Closes #N` / `Refs #N`)
|
|
> - [ ] 已通过 pre-commit-check
|
|
> - [ ] 已更新相关文档
|
|
> - [ ] 已自测通过
|
|
|
|
---
|
|
|
|
## 📋 概要 (Summary)
|
|
<!-- 简短描述这个 PR 做了什么 -->
|
|
|
|
## 🎯 关联 (Related)
|
|
<!-- 关联的 Issue / 需求 / 文档 -->
|
|
|
|
- Closes #
|
|
- Refs #
|
|
|
|
## 🏷️ 类型 (Type of Change)
|
|
<!-- 请勾选 -->
|
|
|
|
- [ ] 🐛 Bug 修复
|
|
- [ ] ✨ 新功能
|
|
- [ ] 📈 性能优化
|
|
- [ ] 🔐 安全修复
|
|
- [ ] 🏗️ 基础设施(部署/工具)
|
|
- [ ] 📚 文档
|
|
- [ ] 🧹 重构
|
|
- [ ] 🧪 测试
|
|
|
|
## 🛠️ 改动 (Changes)
|
|
<!-- 详细描述改动内容 -->
|
|
|
|
### 后端
|
|
- [ ] 改 models(alembic 迁移?)
|
|
- [ ] 改 API 端点
|
|
- [ ] 改 service / utils
|
|
- [ ] 改配置
|
|
|
|
### 前端
|
|
- [ ] admin
|
|
- [ ] agent
|
|
- [ ] h5
|
|
- [ ] portal
|
|
|
|
### 基础设施
|
|
- [ ] Dockerfile
|
|
- [ ] nginx
|
|
- [ ] 脚本
|
|
- [ ] CI/CD
|
|
|
|
### 文档
|
|
- [ ] README
|
|
- [ ] docs/
|
|
- [ ] 注释
|
|
|
|
## 🧪 测试 (Testing)
|
|
<!-- 怎么测试的? -->
|
|
|
|
### 单元测试
|
|
- [ ] 加新测试
|
|
- [ ] 现有测试通过
|
|
|
|
### 集成测试
|
|
- [ ] 后端:`pytest backend/tests/`
|
|
- [ ] 前端:`npm run test`(如有)
|
|
|
|
### 手动测试
|
|
<!-- 手动测试步骤 -->
|
|
|
|
1.
|
|
2.
|
|
3.
|
|
|
|
### 回归测试
|
|
<!-- 是否影响其他模块? -->
|
|
|
|
## 📸 截图/录屏 (Screenshots / Recordings)
|
|
<!-- UI 改动必有 -->
|
|
|
|
## ⚠️ 风险与回滚 (Risks & Rollback)
|
|
<!-- 风险评估,如何回滚 -->
|
|
|
|
### 风险
|
|
<!-- 列出潜在风险 -->
|
|
|
|
### 回滚方案
|
|
<!-- 如何回滚 -->
|
|
|
|
## ✅ 验收清单 (Acceptance Checklist)
|
|
- [ ] 代码风格一致
|
|
- [ ] 注释充分
|
|
- [ ] 类型注解完整(Python)
|
|
- [ ] 无 console.log
|
|
- [ ] 无未使用的 import
|
|
- [ ] 无硬编码(走 config)
|
|
- [ ] 无 token / 凭据
|
|
- [ ] 错误处理完善
|
|
- [ ] 日志记录
|
|
- [ ] 性能考虑
|
|
- [ ] 安全考虑
|
|
|
|
## 📚 文档 (Documentation)
|
|
- [ ] API 文档更新
|
|
- [ ] 用户文档更新
|
|
- [ ] 部署文档更新
|
|
- [ ] CHANGELOG.md 更新
|
|
|
|
## 🔗 关联资源 (References)
|
|
- 相关 PR
|
|
- 相关 Issue
|
|
- 相关文档
|
|
- 外部资源
|
|
|
|
---
|
|
|
|
**Author**: @your-username
|
|
**Reviewer**: @reviewer-username
|
|
**Date**: YYYY-MM-DD
|