SuperAPI AI 工具集

workflows-work

编程与开发

查看项目

更新于 11-12 22:25

技能介绍

用途 workflows-work 用于系统性地执行工作文档(计划、规格说明或 todo 文件),在执行过程中保持代码质量,并完整交付功能。使用前通过 @file/path/to/plan.md 引用工作文档。

执行流程 阶段一:快速启动

  1. 阅读计划并澄清:完整阅读工作文档,查看其中提供的引用与链接;如有不清楚或含糊之处,先提出澄清问题,并取得用户确认后再开始。
  2. 准备环境,选择工作方式:
    • 方式 A:在当前分支直接工作,依次执行 git checkout main && git pull origin main、git checkout -b feature-branch-name。
    • 方式 B:使用 worktree 并行工作(推荐并行开发时使用),通过 @skill/git-worktree 从 main 创建隔离 worktree 中的新分支。
    • 建议:同时处理多个功能、希望在试验时保持 main 干净、需要频繁切换分支时使用 worktree;只做一个功能、希望留在主仓库时使用当前分支。
  3. 创建 Todo 列表:用 markdown 文件或行内方式维护,把计划拆成可执行任务,标注任务间依赖,按优先级排序,包含测试与质量检查任务,保持任务具体且可完成。

阶段二:执行 按优先级逐个处理任务:标记 in_progress → 阅读计划中引用的文件 → 在代码库中寻找相似模式 → 按现有约定实现 → 为新功能写测试 → 运行测试 → 标记 completed。

  • 遵循现有模式:先读计划引用的相似代码,严格匹配命名约定,尽量复用已有组件,遵循项目编码规范(见 @file/AGENTS.md),不确定时用 grep 查找相似实现。
  • 持续测试:每次重要修改后运行相关测试,不要等到最后,失败立即修复,为新功能补测试。
  • 跟踪进度:及时更新 todo 列表,记录阻塞与意外发现,范围扩大时新建任务,在重要里程碑通知用户。

阶段三:质量检查

  • 提交前始终运行完整测试套件与项目配置的 lint。
  • 大型、高风险或复杂改动可选使用:@guidance/code-simplicity-review(检查不必要的复杂度)、@guidance/rails-review(Rails 项目核对约定)、@guidance/performance-review(性能问题)、@guidance/security-review(安全漏洞扫描)。
  • 最终验证:所有 todo 完成、测试通过、lint 通过、代码符合现有模式、无控制台错误或警告。

阶段四:交付 创建提交:git add .、git status(检查提交内容)、git diff --staged(检查改动),然后使用约定格式提交,例如 git commit -m "feat(scope): description of what and why"。 创建 PR:git push -u origin feature-branch-name,再 gh pr create --title "Feature: [Description]" --body "..."。PR 描述包含:构建内容与原因摘要、测试说明、UI 改动的截图(前后对比)。最后向用户总结完成内容、附上 PR 链接、说明后续工作。

核心原则

  • 快速开始:开始时澄清一次即执行,目标是完成功能而非追求完美流程。
  • 以计划为指引:加载计划引用的相似代码与模式并遵循,不要重复造轮子。
  • 随改随测:每次修改后运行测试,失败立即修复。
  • 质量内建:遵循现有模式、为新代码写测试、推送前运行 lint。
  • 交付完整功能:所有任务完成再推进,不留下 80% 完成的功能。

质量检查清单(创建 PR 前) 澄清问题已问并得到回答;所有 todo 标记完成;测试通过;lint 通过;代码遵循现有模式;提交信息符合约定格式;PR 描述包含摘要与测试说明。

常见陷阱 过度分析;跳过澄清问题;忽略计划中的引用;最后才测试;80% 完成综合征。