关于 code-review
code-review 是面向代码审查工作的实践指南,涵盖接收反馈、请求审查和验证门槛,强调先核实技术依据,再报告完成状态。
主要功能
- 01按流程处理审查反馈
- 02系统化请求代码审查
- 03以证据验证完成状态
- 04合并前运行 CI 检查
适用场景
- 01评估来源不明或存疑的审查意见
- 02在功能完成或合并前请求审查
- 03提交前验证类型、测试和 lint
- 04避免未经验证就声称工作完成
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ siviter-xyz/ dot-agent --skill code-review安装后在 Claude Code 中输入/code-review确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/receiving-feedback.mdrequesting-review.mdverification-gates.md详细介绍
代码审查
介绍规范的代码审查实践,强调技术严谨性、基于证据的论断,以及验证优先于形式主义回应。
概述
代码审查需要三项不同的实践:
- 接收反馈 - 重视技术评估,而非形式上的赞同
- 请求审查 - 采用系统化的审查流程
- 验证关卡 - 在声称完成任何工作前,先提供证据
核心原则
技术正确性优先于社交上的舒适感。 实施前先验证。先询问,再假设。提出论断前先提供证据。
适用场景
接收反馈
- 收到来自任何来源的代码审查意见
- 反馈不清楚或在技术上存疑
- 有多项审查意见需要确定优先级
- 外部审查者缺乏完整背景信息
- 建议与现有决策相冲突
请求审查
- 在由子 Agent 驱动的开发中完成任务后(每项任务完成后都要审查)
- 完成主要功能或重构后
- 合并到主分支前
- 陷入困境并需要新的视角
- 修复复杂错误后
验证关卡
- 即将声称测试通过、构建成功或工作已完成
- 提交、推送或创建 PR 前
- 开始下一项任务前
- 任何暗示成功或完成的表述
快速决策树
SITUATION?
│
├─ Received feedback
│ ├─ Unclear items? → STOP, ask for clarification first
│ ├─ From human partner? → Understand, then implement
│ └─ From external reviewer? → Verify technically before implementing
│
├─ Completed work
│ ├─ Major feature/task? → Request systematic review
│ └─ Before merge? → Request systematic review
│
└─ About to claim status
├─ Have fresh verification? → State claim WITH evidence
└─ No fresh verification? → RUN verification command first
CI 验证
在声称完成任何工作或进行提交前:
- 运行 CI 检查(类型、测试、lint)
- 如果有单条 CI 命令,优先使用
- 确认所有检查均已通过
- 如果检查失败,不要继续
参考资料
详细流程请参见:
references/receiving-feedback.md- 如何处理代码审查反馈references/requesting-review.md- 系统化的审查流程references/verification-gates.md- 提出论断前的证据流程
评论
支持 Markdown