SuperAPI AI 工具集

create-walkthrough

测试与质量

查看项目

更新于 10-16 06:49

技能介绍

用途:为 PR 交付生成最终总结文档 walkthrough.md,保存到 .gw/{branch-name}/walkthrough.md,并同时在对话中展示内容。

前提条件:所有测试通过、文档已更新、plan.md 存在且进度日志最新、当前位于 worktree 内。

主要能力:从 git 获取分支名与变更统计,从 plan.md 提取摘要、决策、需求与文件变更表,从测试结果确认状态,按模板生成包含 frontmatter、摘要、变更表、关键决策、测试结果、验证步骤和后续步骤的文档。

使用方式:先运行命令获取路径与 git 信息,注意不要猜测分支名: BRANCH=$(git branch --show-current) && mkdir -p ".gw/${BRANCH}" && echo "Artifact path: .gw/${BRANCH}/walkthrough.md" && echo "---" && git diff --stat main...HEAD && echo "---" && git log --oneline main...HEAD 再读取 plan.md: BRANCH=$(git branch --show-current) && cat ".gw/${BRANCH}/plan.md" 然后按模板写入文件,并在对话中直接输出内容。时间戳必须使用完整 ISO 8601 格式 YYYY-MM-DDTHH:MM:SSZ。

适用场景:PR 交付前的总结与交接,供评审者快速了解变更与验证方式。

限制:需满足前提条件;文件位置与分支名必须由命令获取,不能硬编码或猜测;变更表需与 git diff --stat 一致;测试结果需反映实际运行结果;文件与对话内展示两者均为必需。资料未提供其他平台、收费或效果信息。