SuperAPI AI 工具集

code-quality

编程与开发

查看项目

更新于 10-29 13:22

技能介绍

code-quality 是一个代码审查技能,用法是像本客户团队的资深审查者一样审查分支差异,并修复确有其事的问题。每条发现都必须具体到文件和行号,说明原因并给出修复方案,同时按优先级排序,让开发者先处理重要问题。

用途与流程 先获取差异与上下文:执行 git fetch origin、git diff origin/main...HEAD --stat 与 git diff origin/main...HEAD;若默认分支不是 main 则改用仓库默认分支。同时阅读工单或 PRD 核对范围、仓库地图中的“How we do X here”部分,以及 CONTRIBUTING.md、CODING_STANDARDS.md。资料强调:有文档记录的团队规则优先于通用建议。

先跑工具再人工审查:运行项目已配置的检查,避免把时间花在 linter 能发现的问题上,例如 pre-commit run --from-ref origin/main --to-ref HEAD,或直接运行 ruff、black、isort、flake8、mypy,并执行 python manage.py check、python manage.py makemigrations --check --dry-run、pytest <changed apps>。工具失败要先报告。

三轮审查 第一轮安全(Django/DRF):每个新视图都有明确的 permission_classes,除非有意公开否则不用 AllowAny;get_queryset 按请求用户或组织限定范围,用请求中的 id 直接 Model.objects.get(pk=...) 且无归属检查即 IDOR;序列化器输入字段逐个列出,不用 all,服务端拥有的字段(org、owner、is_staff、status、价格)设为只读并在视图或服务中赋值;原始 SQL、.extra()、RawSQL 必须参数化,不能用 f-string 或 % 拼接;检查 mark_safe、|safe、format_html 误用用户内容,以及会话认证视图上的 csrf_exempt;文件上传检查大小、扩展名与内容类型,存放在 web 根目录之外,不信任文件名;检查代码、配置、fixture、测试中的密钥,以及削弱安全的配置(DEBUG、ALLOWED_HOSTS = ["*"]、带凭据的 CORS );出站请求要有超时,用户输入构造的 URL 要校验(SSRF);谨慎使用 pickle、无 SafeLoader 的 yaml.load、对任何外部内容的 eval/exec;不记录令牌、密码、PII 等敏感数据。 第二轮设计与隐式耦合:信号承载业务逻辑(post_save 接收器发邮件或更新其他模型)会把副作用对调用方隐藏,且 bulk_/update() 时不触发,建议改为服务中的显式调用;序列化器的 create()/update()/validate() 中做多模型写入、外部调用或业务规则,应移到服务层;胖视图(ORM 逻辑重、按业务规则分支);胖模型或 save() 重写带副作用;副作用放在 transaction.on_commit 之外(任务在行提交前入队,任务找不到记录);跨应用导入造成循环依赖,或直接访问其他应用内部而非其服务 API;同一规则多处重复(散弹式修改)、用魔法字符串表示状态而非模型 choices;引入的 N+1(新序列化字段触及关系、遍历查询集);相对工单的范围蔓延与验收标准未满足。 第三轮测试:每个验收标准都有测试,覆盖权限与跨租户场景;测试断言行为而非实现(不 mock 被测代码);有迁移时按 django-migrations 审查。

报告与修复 按安全、设计、测试、小问题分级列出,级别为 Must fix(安全、数据丢失、行为破坏、检查失败)、Should fix(审查者会指出的设计与测试缺口)、Optional。示例格式如“billing/views.py:58 InvoiceVoidView 用 Invoice.objects.get(pk=pk) 且无组织检查 → 任何用户可作废任何组织的发票,改用 self.get_queryset().get(pk=pk)”。之后询问开发者要修哪些,修复并重跑工具与测试,再建议使用 pr-description。

规则与限制 没有文件行号和具体修复的发现不得提出;不指出格式化工具负责的风格问题,也不指出差异之外的既有问题(可另列为“已注意、不在范围内”);不能批准自己没能运行的内容,要说明哪些无法验证。技能本身未提供收费标准、平台支持、效果数据或安装步骤等信息,资料中也没有这些内容。