代码审查和质量

人工智能 社区

技能解读

当前原文的自动摘译,尚未人工审校。

概述

使用质量门进行多维代码审查。每个更改在合并之前都会经过审核——无一例外。审查涵盖五个轴:正确性、可读性、架构、安全性和性能。批准标准:当更改确实改善了整体代码健康状况时,即使它并不完美,也批准更改。完美的代码并不存在——目标是持续改进。不要阻止更改,因为它与您本来的编写方式不完全一样。如果它改进了代码库并遵循项目的约定,请批准它。

何时使用

合并任何 PR 或更改之前 完成功能实现之后 当另一个代理或模型生成您需要评估的代码时 重构现有代码时 任何错误修复之后(查看修复和回归测试)

五轴回顾

每次审查都会从以下维度评估代码:

1. 正确性

该代码是否执行其声称的功能?它符合规范或任务要求吗?是否处理了边缘情况(空、空、边界值)?是否处理了错误路径(不仅仅是快乐路径)?它通过了所有测试吗?这些测试实际上测试的是正确的东西吗?

2. 可读性和简单性

在作者不解释的情况下,其他工程师(或代理)能否理解这段代码?名称是否具有描述性且符合项目惯例? (没有上下文,没有temp、data、result)控制流是否简单(避免嵌套三元组、深度回调)?代码组织是否符合逻辑(相关代码分组、模块边界清晰)?是否有任何应该简化的“聪明”技巧?

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
人工智能
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@addyosmani · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
不需要
兼容的系统
macOS · Linux · Windows
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第一步:了解背景

在查看代码之前,先了解其意图:

02
第 2 步:首先查看测试

测试揭示意图和覆盖范围:

03
第 3 步:审查实施情况

牢记五个轴浏览代码:

04
第 4 步:对结果进行分类

标记每个评论的严重性,以便作者知道什么是必需的,什么是可选的: 前缀 · 含义 · 作者操作 *(无前缀)* · 必需的更改 · 合并前必须解决 严重: · 块合并 · 安全漏洞、数据丢失、功能损坏 Nit: · 次要、可选 · 作者可能会忽略 - 格式、样式首选项

05
第五步:验证验证

查看作者的验证故事:

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。