SuperAPI AI 工具集

pr-checklist

编程与开发

查看项目

更新于 10-16 05:29

技能介绍

PR Checklist Generator 用于根据代码变更生成一份完整的 PR(Pull Request)检查清单,帮助开发者在提交或评审代码前系统性地核对各项要点。

用途 该技能面向代码评审与提交前的自查场景。它会先分析本次变更,再输出一份贴合当前 PR 的检查清单,减少遗漏。

主要能力

  1. 变更分析:分析哪些文件被改动、变更类型(功能、缺陷修复、重构)以及受影响的系统。
  2. 通用检查清单:覆盖多个维度。
    • 代码质量:遵循项目风格指南、无 lint 错误、类型定义正确、无 console.log 或调试代码、复杂逻辑有注释。
    • 测试:新增或更新单元测试、必要时补充集成测试、覆盖边界情况、所有测试通过。
    • 安全:无硬编码密钥、输入经过校验、具备授权检查、无 SQL/XSS 漏洞。
    • 性能:无明显性能问题、数据库查询已优化、合理使用缓存。
    • 文档:必要时更新 README、更新 API 文档、为复杂代码添加行内注释。
  3. 针对具体变更的条目:
    • 数据库变更:本地测试迁移、存在回滚方案、添加 RLS 策略。
    • API 变更:更新 API 文档、保持向后兼容、记录错误响应。
    • UI 变更:验证响应式设计、检查无障碍、处理加载状态。

使用方式 该技能会先分析变更,再生成针对当前 PR 定制的完整检查清单。资料中未提供具体的安装命令、调用参数或代码示例,暂未提供。

适用场景 适用于代码提交前的自查、代码评审准备,以及需要按变更类型核对数据库、API、UI 等专项要点的开发流程。

限制 资料未说明该技能支持的平台、依赖环境、是否收费及价格等信息,暂未提供。