mirror of
https://gitee.com/spark-store-project/spark-store
synced 2026-04-26 09:20:18 +08:00
momen
cef68a95d9
## 文档（全部中文） - AGENTS.md - 完整的 AI 编码指南（中文版） - CONTRIBUTING.md - 贡献指南 - DEVELOPMENT.md - 开发文档 - DEPLOYMENT.md - 部署文档 - TESTING.md - 测试文档 - TROUBLESHOOTING.md - 问题排查指南 - FAQ.md - 常见问题 - WORKFLOW.md - 标准开发流程文档 ## AI 工作流（9个详细工作流） - feature-development.md - 新功能开发流程 - bug-fix.md - Bug 修复流程 - code-review.md - 代码审查流程 - testing.md - 测试编写流程 - release.md - 发布流程 - refactoring.md - 代码重构流程 - documentation.md - 文档更新流程 - performance-optimization.md - 性能优化流程 - security-audit.md - 安全审计流程 ## 测试基础设施 - vitest.config.ts - Vitest 单元测试配置 - playwright.config.ts - Playwright E2E 测试配置 - src/__tests__/setup.ts - 测试环境设置 - src/__tests__/unit/downloadStatus.test.ts - 示例单元测试 - e2e/basic.spec.ts - 示例 E2E 测试 ## CI/CD - .github/workflows/test.yml - 新建测试 CI 工作流 - .github/workflows/build.yml - 更新构建工作流，添加测试步骤 ## Issue 模板 - 更新 bug_report.md 为标准 Bug 报告模板 - 更新 help_wanted.md 为标准功能请求模板 ## 配置更新 - package.json - 添加测试依赖和 7 个新的 npm 脚本 - .gitignore - 添加测试相关忽略项 ## 新增 npm 脚本 - test - 运行单元测试 - test:watch - 监听模式 - test:coverage - 生成覆盖率报告 - test:e2e - 运行 E2E 测试 - test:e2e:ui - E2E UI 模式 - test:e2e:debug - E2E 调试模式 - test:all - 运行所有测试 ## 新增测试依赖 - @playwright/test ^1.40.0 - @testing-library/jest-dom ^6.1.5 - @testing-library/vue ^8.0.1 - @vitest/coverage-v8 ^1.0.0 - @vue/test-utils ^2.4.3 - jsdom ^23.0.1 - vitest ^1.0.0
140 lines
2.4 KiB
Markdown
140 lines
2.4 KiB
Markdown
---
|
||
description: Bug 修复流程
|
||
---
|
||
|
||
## 工作流说明
|
||
|
||
此工作流指导如何修复 Bug。
|
||
|
||
## 步骤
|
||
|
||
### 1. 复现 Bug
|
||
|
||
- 根据 Issue 描述复现问题
|
||
- 记录详细的复现步骤
|
||
- 收集相关日志和错误信息
|
||
- 确认环境信息
|
||
|
||
### 2. 分析问题
|
||
|
||
- 查看相关代码
|
||
- 使用调试器定位问题
|
||
- 检查日志输出
|
||
- 识别根本原因
|
||
|
||
### 3. 创建修复分支
|
||
|
||
```bash
|
||
git checkout -b fix/your-bug-fix
|
||
```
|
||
|
||
### 4. 编写回归测试
|
||
|
||
先编写测试来复现 Bug：
|
||
|
||
```typescript
|
||
// src/__tests__/unit/bugFix.test.ts
|
||
import { describe, it, expect } from "vitest";
|
||
import { buggyFunction } from "@/modules/example";
|
||
|
||
describe("buggyFunction", () => {
|
||
it("should not crash with null input", () => {
|
||
expect(() => buggyFunction(null)).not.toThrow();
|
||
});
|
||
});
|
||
```
|
||
|
||
### 5. 修复代码
|
||
|
||
- 最小化修改
|
||
- 保持代码可读性
|
||
- 添加必要的注释
|
||
- 更新相关类型定义
|
||
|
||
### 6. 运行测试
|
||
|
||
```bash
|
||
# 确保新测试通过
|
||
npm run test
|
||
|
||
# 运行所有测试
|
||
npm run test:all
|
||
|
||
# 代码检查
|
||
npm run lint
|
||
npm run format
|
||
```
|
||
|
||
### 7. 本地验证
|
||
|
||
- 验证 Bug 已修复
|
||
- 测试相关功能
|
||
- 检查是否引入新问题
|
||
- 测试边界情况
|
||
|
||
### 8. 更新文档
|
||
|
||
- 更新 CHANGELOG.md（如果需要）
|
||
- 更新相关文档（如需要）
|
||
|
||
### 9. 提交代码
|
||
|
||
```bash
|
||
git add .
|
||
git commit -m "fix(scope): describe the bug fix" -s
|
||
git push origin fix/your-bug-fix
|
||
```
|
||
|
||
### 10. 创建 Pull Request
|
||
|
||
- 引用相关 Issue（`Fixes #123`）
|
||
- 描述修复方法
|
||
- 说明复现步骤
|
||
- 添加测试说明
|
||
|
||
### 11. 代码审查
|
||
|
||
- 响应审查意见
|
||
- 进行必要的修改
|
||
- 确保所有 CI 检查通过
|
||
|
||
### 12. 合并
|
||
|
||
- 等待审查批准
|
||
- Squash 合并到 main 分支
|
||
- 删除修复分支
|
||
|
||
## 注意事项
|
||
|
||
- ⚠️ 修复前先理解问题根源
|
||
- ⚠️ 最小化修改范围
|
||
- ⚠️ 添加回归测试防止复发
|
||
- ⚠️ 考虑向后兼容性
|
||
- ⚠️ 测试所有受影响的功能
|
||
|
||
## 常见 Bug 类型
|
||
|
||
### IPC 通信问题
|
||
|
||
- 检查事件名称是否匹配
|
||
- 检查数据格式是否正确
|
||
- 检查异步处理
|
||
|
||
### 状态管理问题
|
||
|
||
- 检查响应式依赖
|
||
- 检查状态更新时机
|
||
- 检查内存泄漏
|
||
|
||
### 类型错误
|
||
|
||
- 检查类型定义
|
||
- 检查类型断言
|
||
- 检查可选值处理
|
||
|
||
## 相关文档
|
||
|
||
- [CONTRIBUTING.md](../../CONTRIBUTING.md) - 贡献指南
|
||
- [TESTING.md](../../TESTING.md) - 测试文档
|
||
- [TROUBLESHOOTING.md](../../TROUBLESHOOTING.md) - 问题排查
|