version: "1.0.0" name: vibe-review description: Use this skill to perform code reviews, checking for quality, security, and standard compliance.

代码检查工作流

1. 文档目的

规范代码检查流程，确保前端和后端代码按照开发计划文档进行开发，验证前端与后端的接口调用是否正常，保证项目质量和开发进度。

2. 工作流结构

一个完整的代码检查工作流应包含：

• 基本信息：名称、目标
• 前置步骤：产物检查、依赖项确认
• 执行步骤：详细的执行流程和顺序
• 执行建议：专业建议和注意事项
• 成功标准：任务完成的判定条件
• 失败处理：异常情况的应对措施
• 输出成果：明确的交付物和保存位置

3. 执行要求

• 严格按照步骤执行
• 与用户保持深度沟通
• 记录关键信息和结果
• 遇到异常时按失败处理机制执行
• 确保输出成果符合用户预期

4. 文档管理

• 执行后根据实际情况更新文档
• 进行版本管理，确保使用最新版本

5. 工作流程

前置步骤：准备工作

1. 检查项目开发阶段：

• 查看./.vibe/stage.md文件，确认当前项目开发阶段
• 如果阶段未设定，提示用户先执行项目阶段开发计划工作流

1. 检查开发计划文档：

• 确认./项目文档/开发计划/前端开发文档（前端开发计划）.md文件是否存在
• 确认./项目文档/开发计划/后端开发文档（后端开发计划）.md文件是否存在
• 确认./项目文档/开发计划/项目阶段开发计划总览.md文件是否存在
• 如果不存在，提示用户先执行项目阶段开发计划工作流

1. 检查前端和后端目录：

• 确认./frontend目录是否存在
• 确认./backend目录是否存在
• 如果不存在，提示用户先执行前端开发工作流和后端开发工作流

1. 检查前端和后端开发文档：

• 确认./frontend/doc目录下是否存在前端开发手册
• 确认./backend/doc目录下是否存在后端开发手册
• 如果不存在，提示用户先执行前端开发工作流和后端开发工作流

第一步：读取相关文档

1. 读取开发计划文档：

• 读取./项目文档/开发计划/前端开发文档（前端开发计划）.md文件
• 读取./项目文档/开发计划/后端开发文档（后端开发计划）.md文件
• 读取./项目文档/开发计划/项目阶段开发计划总览.md文件
• 了解当前阶段的开发任务和要求

1. 读取前端和后端开发手册：

• 读取./frontend/doc目录下的前端开发手册
• 读取./backend/doc目录下的后端开发手册
• 了解前端和后端的技术选型、API调用方式等

1. 读取API设计规范文档：

• 读取./.vibe/workflows/api-rules.md文件
• 了解API设计规范和要求

第二步：前端代码检查

1. 代码结构检查：

• 检查前端代码结构是否符合开发计划文档的要求
• 确认是否按照模块化原则进行开发
• 检查代码文件组织是否合理

1. 功能实现检查：

• 检查当前阶段的前端功能是否按照开发计划文档实现
• 确认功能模块是否完整
• 检查功能实现是否符合需求

1. API调用检查：

• 检查前端代码中的API调用是否符合API设计规范
• 确认API调用的参数、路径、方法等是否正确
• 检查API调用的错误处理和异常捕获是否完善

1. 代码质量检查：

• 检查前端代码结构是否清晰，逻辑是否流畅
• 检查代码是否符合前端编码规范和最佳实践
• 检查代码的可维护性和可扩展性

1. UI 质量检查（参照 vibe-ui-design 第 17 节 Pre-Delivery Checklist）：

• 视觉规范：颜色/间距/圆角/阴影是否全用 token，无硬编码
• 交互规范：hover/active/disabled 三态是否完整，hover 不改布局
• 可访问性：对比度≥4.5:1，键盘可达，焦点可见
• 响应式：375px/768px/1440px 三档布局不破
• 一致性：Button/Input/Card/Modal 是否全用组件库，无原生标签

1. 测试验证：

• 对前端功能进行测试
• 验证功能是否符合需求
• 测试API调用是否正常

第三步：后端代码检查

1. 代码结构检查：

• 检查后端代码结构是否符合开发计划文档的要求
• 确认是否按照模块化原则进行开发
• 检查代码文件组织是否合理

1. 功能实现检查：

• 检查当前阶段的后端功能是否按照开发计划文档实现
• 确认功能模块是否完整
• 检查功能实现是否符合需求

1. API实现检查：

• 检查后端代码中的API实现是否符合API设计规范
• 确认API的参数、返回值等是否正确
• 检查API的错误处理和异常捕获是否完善

1. 代码质量检查：

• 检查后端代码结构是否清晰，逻辑是否流畅
• 检查代码是否符合后端编码规范和最佳实践
• 检查代码的可维护性和可扩展性

1. 测试验证：

• 对后端功能进行测试
• 验证功能是否符合需求
• 测试API是否正常响应

第四步：前后端联调检查

1. 接口对接检查：

• 检查前端和后端的接口对接是否正常
• 确认前端调用的API与后端实现的API是否一致
• 检查API调用的参数和返回值是否匹配

1. 联调测试：

• 进行前后端联调测试
• 验证前端是否可以成功调用后端API
• 检查数据传输是否正常
• 测试各种场景下的接口调用

1. 错误处理检查：

• 检查前端和后端的错误处理机制是否完善
• 验证异常情况下的处理是否合理
• 检查错误信息是否清晰明确

第五步：问题文档编写

1. 问题收集：

• 收集前端代码检查中发现的问题
• 收集后端代码检查中发现的问题
• 收集前后端联调检查中发现的问题

1. 问题分类：

• 将问题按照类型分类（如代码结构、功能实现、API调用、代码质量等）
• 对问题进行优先级排序

1. 问题文档编写：

• 创建问题文档，详细描述每个问题
• 提供问题的具体位置和示例
• 给出问题的解决方案建议

1. 文档保存：

• 将问题文档保存至./项目文档/开发计划/代码检查问题报告.md
• 与用户沟通问题文档内容

6. 执行建议

1. 全面检查：对前端和后端代码进行全面检查，确保所有功能模块都符合开发计划文档的要求
2. 严格规范：严格按照API设计规范和编码规范进行检查，确保代码质量
3. 详细记录：详细记录检查过程中发现的问题，包括问题的具体位置和示例
4. 联调测试：充分进行前后端联调测试，确保接口对接正常
5. 问题追踪：对发现的问题进行追踪，确保问题得到及时解决
6. 沟通协作：与前端和后端开发人员保持密切沟通，确保问题得到有效解决
7. 文档同步：及时更新代码检查问题报告，确保文档与实际情况同步

7. 成功标准

1. 代码检查完成：完成前端和后端代码的全面检查
2. 联调测试通过：前端可以成功调用后端API，数据传输正常
3. 问题文档完整：代码检查问题报告编写完成，内容详细准确
4. 问题追踪有效：对发现的问题进行有效追踪和解决
5. 符合开发计划：前端和后端代码按照开发计划文档进行开发

8. 失败处理

1. 文档缺失：如果必要的文档不存在，提示用户先创建文档
2. 代码缺失：如果前端或后端代码不存在，提示用户先执行开发工作流
3. API不一致：如果前端调用的API与后端实现的API不一致，记录问题并提出解决方案
4. 联调失败：如果前后端联调失败，分析原因并提出解决方案
5. 问题解决延迟：如果问题解决延迟，与用户沟通并调整计划

9. 输出成果

1. 代码检查问题报告：详细的问题描述和解决方案建议 - 保存至./项目文档/开发计划/代码检查问题报告.md
2. 前端代码检查结果：前端代码检查的详细结果 - 保存至./项目文档/开发计划/前端代码检查结果.md
3. 后端代码检查结果：后端代码检查的详细结果 - 保存至./项目文档/开发计划/后端代码检查结果.md
4. 前后端联调测试报告：前后端联调测试的详细结果 - 保存至./项目文档/开发计划/前后端联调测试报告.md
5. 阶段检查日志：记录代码检查的过程和结果 - 保存至./项目文档/开发计划/阶段检查日志.md

10. 注意事项

• 每次代码检查前必须查看当前项目开发阶段
• 严格按照开发计划文档和API设计规范进行检查
• 充分进行前后端联调测试，确保接口对接正常
• 详细记录检查过程中发现的问题
• 与开发人员保持密切沟通，确保问题得到及时解决
• 及时更新代码检查问题报告，确保文档与实际情况同步

通过本工作流的执行，确保前端和后端代码按照开发计划文档进行开发，验证前端与后端的接口调用是否正常，保证项目质量和开发进度。