SuperAPI AI 工具集

pr-tech-spec-generator

写作与研究

查看项目

更新于 10-15 19:58

技能介绍

用途:该技能分析 GitHub PR 并生成结构化技术文档,适合在用户提供 PR URL 并需要文档或技术规格时使用。

主要能力:通过 gh CLI 获取 PR 元数据,分析本地仓库的 git diff,检测数据库迁移与 schema 变更、API 端点变更、测试文件变更、依赖版本更新以及函数/类/导出等代码改动,最终生成包含概述、变更统计、目录结构、提交历史、DB schema、API 定义、主要改动、测试、依赖和生成信息的 Markdown 规格文档。

使用方式:基本命令为 python scripts/generate_spec.py <pr-url>;可加 --repo-path /path/to/repo 指定仓库路径,或 --output-dir /path/to/output 指定输出目录。输出默认写入 outputs/ 目录并带时间戳。

前提条件:需安装并认证 gh CLI(gh auth login),需本地 git 仓库(分支缺失时会自动尝试拉取),需 Python 3.6+。脚本可处理远程分支不存在、仅本地分支或分支以提交哈希指定的情况。

限制:检测基于正则,可能误报;超大 PR 会生成冗长文档;语言/框架无关的检测可能遗漏项目特定模式。自定义检测模式可编辑 scripts/generate_spec.py 中的模式列表,输出结构可修改 generate_spec_document() 函数,模板参考 spec-template.md。