Files
hzdyjs/.serena/memories/completion_checklist.md
T
zlwu 249b1dfeb4 feat: 完善项目开发规范和测试文档体系
📝 主要改进:
• Cursor配置模块化:拆分为前端、后端、移动端、文档、API测试5个专门规范文件
• API文档重新组织:按业务模块拆分到docs/开发文档/API/目录下
• 新增维修分类功能完整测试方案和自动化测试脚本
• 后端热启动脚本完善,支持Linux/Windows双平台
• 强化文档同步更新规范,确保代码与文档一致性

🔧 技术改进:
• 优化Cursor AI工作流程和代码生成质量
• 完善API测试规范(AES+RSA双重加密登录方法)
• 提升开发效率和代码质量标准化程度

�� 测试覆盖:
• 维修分类管理功能端到端测试验证通过
• 包含页面加载、CRUD操作、搜索功能等核心测试用例

更新时间:2025-07-01
2025-07-01 17:53:05 +08:00

3.5 KiB

任务完成检查清单

开发完成后必须执行的检查项

代码质量检查

  • 编译检查: 确保代码无编译错误

    cd backend && mvn clean compile
    cd web && npm run type-check
    
  • 代码格式检查: 运行代码格式化工具

    cd backend && mvn checkstyle:check
    cd web && npm run lint
    
  • 单元测试: 运行并确保测试通过

    cd backend && mvn test
    cd web && npm run test
    

功能验证检查

  • 接口测试: 使用Postman或Swagger测试所有新增/修改的API
  • 权限验证: 确认按钮和接口权限控制正常
  • 数据权限: 验证多租户数据隔离
  • 异常处理: 测试异常情况的处理逻辑
  • 参数校验: 验证前后端参数校验规则

数据库检查

  • SQL语法: 确保所有SQL语句语法正确
  • 索引优化: 检查查询性能,添加必要索引
  • 数据完整性: 验证外键约束和数据一致性
  • 备份脚本: 更新数据库变更脚本

文档更新检查

  • API文档: 更新Swagger接口文档
  • 数据库文档: 更新表结构文档
  • 业务文档: 更新相关业务流程文档
  • 变更记录: 在 docs/变更管理/ 中记录代码变更
  • 用户手册: 如有界面变更,更新用户操作手册

安全检查

  • SQL注入: 确保使用参数化查询
  • XSS防护: 检查前端输入过滤
  • 敏感信息: 确保没有硬编码密码或密钥
  • 权限控制: 验证所有接口都有适当的权限控制

性能检查

  • 查询优化: 检查数据库查询性能
  • 缓存使用: 合理使用Redis缓存
  • 内存泄漏: 检查是否有内存泄漏问题
  • 并发测试: 验证并发场景下的系统稳定性

部署准备

  • 环境配置: 检查开发、测试、生产环境配置
  • 依赖管理: 确保所有依赖版本正确
  • 启动脚本: 验证启动脚本正常工作
  • 健康检查: 配置应用健康检查端点

代码提交检查

  • Git提交: 使用规范的提交信息格式

    feat: 添加报修订单状态更新功能
    fix: 修复用户权限验证问题
    docs: 更新API接口文档
    style: 修复代码格式问题
    refactor: 重构报修服务层代码
    test: 添加单元测试用例
    
  • 代码审查: 如果是团队开发,提交PR进行代码审查

  • 冲突解决: 解决所有merge冲突

  • 分支管理: 确保功能分支合并到正确的目标分支

验收测试

  • 功能测试: 按照需求文档验证所有功能点
  • 回归测试: 确保新功能不影响已有功能
  • 用户体验: 验证界面友好性和操作流畅性
  • 兼容性测试: 测试主流浏览器和设备兼容性

发布准备

  • 版本标记: 更新版本号和发布说明
  • 发布文档: 准备发布说明和操作指南
  • 回滚方案: 准备发布失败的回滚方案
  • 监控配置: 配置生产环境监控和告警

紧急修复流程

对于紧急修复(hotfix),可以简化部分检查项,但以下项目是必须的:

  • 编译检查
  • 核心功能测试
  • 变更记录更新
  • 安全检查
  • 回滚方案准备

检查工具推荐

  • 代码质量: SonarQube
  • 安全扫描: OWASP ZAP
  • 性能测试: JMeter
  • 接口测试: Postman/newman
  • 数据库: Navicat Premium