代码评审
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_c19c8ed5/awesome-code-review。
技能介绍
解决的评审盲区
很多代码评审会陷入命名、格式、单行写法,忽略真正会导致线上问题的业务语义、状态机偏离、异常补偿缺失和并发/事务风险。这个技能面向 Git 分支变更,把评审重点收敛到业务实现与设计一致性、逻辑正确性与简洁性以及核心架构与并发安全。它先读取 ./review/ 下的需求或设计文档,再对照 origin/master...HEAD 的变更文件,避免只看 diff 片段后做判断。
工作方式
核心流程包括:
- 环境感知:执行
git fetch origin master --depth=1、git branch --show-current和git --no-pager diff --name-status origin/master...HEAD,识别当前分支与变更文件;若变更文件超过 20 个,会提示优先评审核心业务线。 - 上下文加载:扫描
./review/目录,读取.md、.docx等文档;对.docx可借助docx-reader或read_docx.py提取文本与图片,帮助理解流程图、状态机和业务约束。 - 深度审查:不只看 diff,而是读取复杂方法完整上下文,交叉验证代码逻辑与设计文档是否一致、异常分支是否完整、是否存在过度设计或更简洁实现。
- 报告落盘:生成
./review/review_[分支名].md,分支名中的/替换为_;报告包含业务概览、安全评估、核心隐患、逻辑优化、肯定项和待确认问题。
适用边界
它更适合有明确需求文档、概要设计或状态机说明的业务代码评审。如果没有文档,技能会标注为仅基于代码推演,结论可信度会下降。对于纯格式、命名、注释风格类问题,它不会作为核心评审维度;对于高度依赖运行环境、外部系统或历史包袱的改动,仍需结合测试与线上上下文判断。
使用场景
- 当前分支修改订单状态机和异常补偿逻辑,需要结合 .md 设计文档检查代码是否偏离设计。
- 一次变更涉及 20 多个文件,需要在评审前识别核心业务线变更并输出风险概览。
- 代码能跑但存在冗余调用和过度设计,需要找出可降维实现并保留架构师肯定项。
- 团队要求每个 MR 后归档评审报告,需要生成 ./review/review_分支名.md 并规范分支名。
适合人员
- 负责业务服务后端的工程师:希望 MR 评审聚焦状态机、异常分支和事务一致性,而不是格式细节。
- 需要做代码把关的架构师:希望从并发、缓存、大事务角度识别可能导致 P0/P1 的隐患。
- 接手旧业务模块的开发者:希望结合设计文档确认当前分支是否实现了真实业务意图。
- 需要沉淀评审结论的技术负责人:希望把风险、疑问和肯定项写成可归档的报告。