代码审查偏好Skill code-review-preferences

代码审查技能,用于指导团队进行高效、规范的代码审查。包含审查理念、三遍审查法、审查标准和反馈风格。关键词:代码审查,代码质量,PR审查,团队协作,软件开发流程,代码规范,审查标准,反馈技巧。

测试 0 次安装 4 次浏览 更新于 3/3/2026

name: code-review-preferences description: 在审查代码、PR或讨论代码质量标准时使用。应用团队编码标准和审查方法。

<essential_principles>

代码审查理念

审查的目的是:

  1. 在生产前发现错误
  2. 在团队中分享知识
  3. 保持代码库的一致性

审查的目的不是:

  • 炫耀知识
  • 强制执行个人风格偏好
  • 不必要地阻碍进展

三遍审查法

第一遍:理解(先不要评论)

  • 这个变更试图做什么?
  • 哪些文件受到影响?
  • 范围是什么?

第二遍:正确性

  • 有错误吗?
  • 边缘情况处理了吗?
  • 有安全问题吗?

第三遍:改进(最多5条评论)

  • 代码可读吗?
  • 代码可维护吗?
  • 有更好的模式吗?

审查标准

必须检查

  • [ ] 测试通过
  • [ ] 没有明显错误
  • [ ] PR描述中的边缘情况已处理
  • [ ] 没有安全漏洞
  • [ ] 代码中没有机密信息

应该检查

  • [ ] 代码可读
  • [ ] 函数大小合理(<50行)
  • [ ] 名称清晰且具有描述性
  • [ ] 错误信息有帮助

最好检查

  • [ ] 性能考虑
  • [ ] 文档已更新
  • [ ] 与现有模式一致

反馈风格

应该:

  • 提问:“如果X为空会发生什么?”
  • 具体:“第42行:考虑使用保护子句”
  • 认可好的工作:“这里的重构很棒”
  • 限制评论:每次审查最多5条

不应该:

  • 命令式:“你必须做X”
  • 模糊:“这个可以更好”
  • 挑剔风格:“我更喜欢单引号”
  • 堆砌:20条评论会让人不知所措 </essential_principles>

<intake> 您希望我审查什么?

  1. 格式

    • 在此处粘贴代码/差异
    • 使用@filename引用文件
    • 描述PR,我会提问
  2. 上下文

    • 错误修复
    • 新功能
    • 重构
    • 性能优化
    • 其他:___
  3. 具体关注点? (安全性、性能、破坏性变更等)

在您回答后,我将开始审查。 </intake>