快速开始:5 分钟完成第一次代码“体检”

快速开始:5 分钟完成第一次代码“体检”

Written By
技能练习生
技能练习生

想要体验这个专业的代码评审官?不需要繁琐的配置,只要你手头有正在写的代码,哪怕是一个小函数,都可以立刻开始。

准备工作

首先,我们需要让审查官知道我们要看哪一段。在你的终端里输入这两行命令来获取代码的版本号(SHA):

# 获取上一次提交的版本
BASE_SHA=$(git rev-parse HEAD~1)
# 获取当前的版本
HEAD_SHA=$(git rev-parse HEAD)

如果你是在协助 Pi 开发,通常 Pi 会自动帮你处理这些细节,你只需要发起请求。

第一次尝试

想象你刚刚完成了一个“添加用户注销功能”的任务。你可以直接对 Pi 说:

“我想请 code-reviewer 帮我审一下刚才的代码。”

或者手动填入这个请求:

我刚刚实现了:用户注销功能及其对应的数据库清理逻辑 参考文档:项目需求文档里的任务 3 版本范围:从 a7981ec3df7661(即你刚才获取的两个 SHA) 简要说明:添加了 deleteUser() 函数,并确保级联删除了关联的数据表。

会发生什么

稍微等待几秒钟,你会收到一份直观的清单:

  1. 优势:它会夸奖你写得好的地方,比如“错误处理非常严谨”。
  2. 问题点:它会直接指出隐患。比如“重要:删除了用户但没清理缓存”或者“次要:变量命名不符合规范”。
  3. 最终结论:它会告诉你“可以继续”还是“建议先修复重要问题”。

这就好比提交正式作业前,先找学霸同桌帮忙扫了一眼——那些尴尬的小低级错误,从此消失在进入主分支之前。