| name | code-review |
| description | Procedural code review rules with high-impact security and maintainability patterns. |
代码审查规范
高质量代码 Review 指南，涵盖安全性、性能及可维护性。
快速开始
5 步上手
- 准备代码 - 选择需要审查的代码片段或 PR
- 触发技能 - 在 AI 工具中输入
/code-review-full
- 粘贴代码 - 提供代码上下文和相关文件
- 获取报告 - AI 生成详细的审查报告
- 迭代改进 - 根据建议修复问题并重新审查
使用示例
/code-review-full
请审查以下用户登录代码，重点关注安全性和错误处理：
[粘贴代码]
工作流程
graph TD
A[代码提交] --> B[自动检查]
B --> C{通过?}
C -->|否| D[修复问题]
D --> B
C -->|是| E[人工审查]
E --> F{通过?}
F -->|否| G[反馈修改]
G --> D
F -->|是| H[合并代码]
style A fill:#e1f5ff
style H fill:#c8e6c9
加载文件
相关 Skills
- testing-strategy, refactoring-guide, api-design
示例
检查清单
最佳实践
审查原则
- ✅ 建设性反馈 - 提供具体的改进建议，而非批评
- ✅ 关注重点 - 优先检查安全性、正确性、性能
- ✅ 保持一致 - 遵循团队统一的代码规范
安全审查
- ✅ 检查 SQL 注入、XSS、CSRF 等常见漏洞
- ✅ 验证输入验证和输出编码
- ✅ 审查敏感数据处理和权限控制
性能审查
- ✅ 识别 N+1 查询问题
- ✅ 检查不必要的循环和递归
- ✅ 评估数据库索引使用情况
可维护性
- ✅ 确保命名清晰、语义明确
- ✅ 检查代码重复，遵循 DRY 原则
- ✅ 验证错误处理和日志记录
常见问题
Q: 审查应该多详细?
A: 根据代码重要性和风险级别调整。核心代码需要更详细的审查，辅助代码可适当简化
Q: 如何处理审查意见冲突?
A: 优先考虑安全性、正确性问题。风格问题遵循团队规范，必要时进行团队讨论
Q: 审查耗时太长怎么办?
A: 使用快速检查模式 (/code-review-quick)，分批审查，或设置审查时间上限
Q: 如何提高审查效率?
A: 建立审查清单，使用自动化工具（linter、静态分析），专注关键问题
触发指令
⚠️ Prompt-as-Code (v5.0): 触发指令已迁移至 metadata.json。支持：
/code-review-full - 完整代码审查/code-review-quick - 快速检查/code-review-security - 专注安全审查
Token 效率
- 主 Skill 文件: ~250 tokens
- 参考指南总计: ~3k+ tokens
深度总结：AI 技能优化与维护指南
核心原则
为确保 AI 工具能够有效使用技能，发挥最大作用，我们制定了以下核心原则：
1. 文档更新与 SOP 管理
深度分析
文档是技能使用的基础，完整准确的文档能够显著提升 AI 工具的使用效果。定期更新文档不仅能反映最新的流程变化，还能防止未来出现错误。
最佳实践
- 定期审查：每月检查一次文档，确保内容与实际流程一致
- 版本控制：使用语义化版本号记录文档变更，维护详细的变更日志
- SOP 标准化：将标准操作流程 (SOP) 细化为可执行的步骤，包含前置条件、执行步骤、预期结果和异常处理
- 视觉增强：使用 Mermaid 流程图和架构图可视化复杂流程，提升 AI 理解能力
- 多语言支持：为核心技能提供中英双语文档，适配国际化环境
执行步骤
- 识别变更点：分析流程变更的具体内容和影响范围
- 更新文档：修改相关文档，确保内容准确反映新流程
- 验证一致性：检查所有相关文档是否同步更新
- 测试执行：按照更新后的 SOP 执行操作，验证流程有效性
- 记录变更：在变更日志中记录详细的修改内容和原因
2. 代码库深度分析
深度分析
深入而广泛地分析代码库是确保技能有效性的关键。通过系统性分析，可以发现潜在问题，优化技能实现，提升 AI 工具的使用体验。
分析维度
- 结构分析：检查技能文件结构是否符合标准，验证必需文件是否存在
- 内容分析：审核技能逻辑、工作流程、Mermaid 流程图和最佳实践
- 脚本验证：运行验证脚本检查技能结构和规则文件
- 依赖分析：检查外部服务集成和参数化配置
- 性能分析：评估 Token 使用效率和响应速度
执行步骤
- 结构检查：使用
validate-skill.py 验证技能文件结构
- 规则验证：使用
lint-rules.py 检查规则文件的完整性
- 功能测试：使用
test-skill.py 测试技能的功能和性能
- 问题识别：记录发现的问题和改进机会
- 优化实施：根据分析结果优化技能实现
常见问题
- 文件缺失：缺少必需的 SKILL.md 或 metadata.json 文件
- 结构不符合标准：缺少建议的章节或目录
- 内容不完整：缺少工作流程、最佳实践或常见问题
- 格式错误：JSON 解析错误或 Markdown 格式问题
- 性能问题：Token 使用效率低或响应速度慢
3. AI 工具特定操作步骤
深度分析
不同 AI 工具具有不同的特性和使用方式，为每个工具提供特定的操作步骤能够显著提升使用效果。通过创建工具特定的文件，可以确保用户能够根据使用的工具获取最适合的操作指南。
工具特性分析
- Claude：支持复杂的多步骤任务，擅长深度思考和推理
- Cursor：专注于代码编辑和生成，集成在 IDE 中使用
- Trae：支持多技能协同工作流，提供可视化界面
- Antigravity：专注于创意内容生成和设计
- Codex：擅长代码理解和生成，支持多种编程语言
工具特定文件
为每个 AI 工具创建专门的操作指南文件：
- CLAUDE.md：Claude 特定的操作步骤和最佳实践
- CURSOR.md：Cursor 特定的操作步骤和最佳实践
- TRAE.md：Trae 特定的操作步骤和最佳实践
- ANTIGRAVITY.md：Antigravity 特定的操作步骤和最佳实践
- CODEX.md：Codex 特定的操作步骤和最佳实践
执行步骤
- 工具选择：根据任务需求选择合适的 AI 工具
- 文件查阅：参考对应工具的操作指南文件
- 环境准备：确保工具配置正确，网络连接稳定
- 技能激活：使用工具特定的触发指令激活技能
- 需求描述：清晰描述任务需求和预期结果
- 执行监控：观察工具执行过程，必要时提供额外信息
- 结果评估：检查输出是否符合预期，进行必要的调整
- 迭代优化：基于反馈持续优化使用方法
工具特定最佳实践
- Claude：使用详细的指令，提供充分的上下文信息
- Cursor：在代码编辑器中使用，结合文件内容提供具体指令
- Trae：利用多技能协同工作流，定义清晰的任务序列
- Antigravity：提供创意方向和风格参考，鼓励多样化输出
- Codex：提供具体的代码示例和上下文，明确指定编程语言
实施建议
集成策略
- 统一入口：在每个技能的 SKILL.md 文件中添加所有 AI 工具的参考链接
- 工具切换：提供工具间切换的指南，确保用户能够根据任务需求选择最合适的工具
- 性能对比：记录不同工具在相同任务上的表现，帮助用户做出更明智的选择
维护策略
- 定期更新：每月更新一次工具特定的操作指南，反映工具的最新特性
- 用户反馈：收集用户反馈，持续优化操作步骤
- 案例积累：记录成功案例和最佳实践，丰富操作指南内容
培训策略
- 新用户引导：为新用户提供详细的入门指南，帮助他们快速掌握技能使用方法
- 高级技巧：为经验丰富的用户提供高级技巧和优化策略
- 场景化培训：针对不同场景提供具体的使用示例和最佳实践
通过遵循以上原则和实施建议，我们可以确保 AI 工具能够有效使用技能，发挥最大作用，为用户提供高质量的服务。
AI 工具参考
