SuperAPI AI 工具集

cdk-review-principles

通用与其它

查看项目

更新于 10-15 19:58

技能介绍

用途:这是 AWS CDK 各评审维度技能(回归、安全、测试、文档、构造设计评审)共同遵循的基础规则集,用于统一评审标准,避免各维度规则各自漂移。维度技能只决定标记什么、如何校准,不重新定义本规则。

主要能力:

  1. 严重度分级。按触发后的实际危害评级,仅三档:BLOCKING(造成损害,如资源被替换导致数据丢失、IAM 策略 Resource:"" 打开安全边界,合并前必须修复)、RECOMMENDED(造成腐化,如 s3: 过度授权,应修但不阻塞)、OPTIONAL(危害可忽略的纯润色)。严重度字段只能取这三个词,其他 High/Medium/Low、P0/P1/P2 等体系需按危害映射后弃用。
  2. 危害校准。置信度不等于严重度;礼貌措辞不改变严重度;无危害不报;只评本次 PR 新引入的危害,不评既有问题。违反仓库自身指南(AGENTS.md、CONTRIBUTING.md、docs/AGENTS_*)时,按规则自述的危害定档,并引用文件与章节原文。
  3. 让每条发现可落地。每条需含精确位置(如 path/to/file.ts:L42 或 L42-L50)、证据(优先 AWS 文档,其次 CDK 源码、设计指南、CloudFormation 资源规范、issue/PR、现有测试;引用前必须查证,不得凭记忆)、具体修复建议。无代码位置的发现只能作为高层观察,不能成为行内评论。
  4. 控制评论量。每次评审目标 3-7 条,保留全部 BLOCKING,再取危害最高的 RECOMMENDED,预算允许才加 OPTIONAL。
  5. 共享排除项。既有问题、纯外观(拼写、格式、命名偏好等)、超出本维度范围、为凑数找茬、发布工具/单仓库标记,均不作为发现。

使用方式:各维度技能在 references/*-rules.md 中维护详细规则,按家族分组、组内按 BLOCKING→RECOMMENDED→OPTIONAL 排序、[id] 稳定;条件严重度合并为一条规则,行头写主档、正文说明升降档条件。生成发现前需参考 references/pr-comment-format.md 了解结构化字段与写法。

适用场景:对 aws/aws-cdk 仓库的 PR 进行多维度代码评审时,作为统一底座。

限制:资料未提供安装命令、收费、平台支持等信息;本技能本身不定义具体维度的标记内容。