code-workflow

一个遵循四阶段(研究、计划、评审、实现)的代码变更工作流工具。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:code-workflow。
它的用途是:一个遵循四阶段(研究、计划、评审、实现)的代码变更工作流工具。
完整的 Skill 内容见:https://321skill.com/skills/code-workflow/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“使用code-workflow skill,为我们的用户个人资料页面添加一个暗色模式切换功能。”,它会首先引导你研究现有UI组件和状态管理逻辑,然后生成一份包含组件修改、状态变量和测试用例的详细计划文档(plan.md)。在获得你对计划的确认或修改后,它会基于TDD原则,先写测试,再实现功能代码,最后自动提交更改并创建一个附带界面切换效果GIF的Pull Request。

介绍

这个Skill旨在解决开发者在处理代码变更(如修复问题、实现新功能)时流程混乱、缺乏规划、沟通不畅和代码质量不稳定的问题。它提供了一个结构化的四阶段工作流:研究(Research)、计划(Plan)、用户评审(User Review)和实现(Implement),强制开发者在编码前进行充分调研和设计,并将用户反馈纳入流程,从而减少返工,提升代码质量和团队协作效率。

使用时,开发者只需向AI描述需要处理的代码变更任务(例如“为登录功能添加双因素认证”),该Skill便会引导用户依次完成四个阶段。在研究阶段,它会帮助分析相关代码和文档;在计划阶段,生成详细的实现计划(通常为Markdown格式);在评审阶段,协助收集用户或团队成员对计划的反馈;最后在实现阶段,默认采用测试驱动开发(TDD)方式编写代码、构建、提交,并可自动捕获变更(如截图、GIF)并生成Pull Request。

它非常适合需要遵循严谨开发流程的团队开发者,特别是全栈开发、后端开发、前端开发以及负责代码质量和项目管理的角色。对于个人开发者,它也能帮助建立良好的编码习惯,尤其是在处理复杂或需要协作的功能时。

建议在开始任何非琐碎的代码修改时使用此Skill。注意,其默认启用TDD,如果项目不适用,可以在指令中明确添加--no-tdd参数来跳过。此外,它深度集成GitHub流程,能自动处理分支、提交和PR创建,非常适合在GitHub托管的项目中使用。

核心特点

与一般代码生成或任务管理Skill不同,它强制推行一个包含“用户评审”环节的完整四阶段工作流,并将TDD作为默认实现方式,确保代码变更在提交前经过充分的设计讨论和质量验证。

注意事项

不适合需要快速原型验证或进行简单、一次性脚本编写的场景,其结构化流程可能会显得繁琐。

常见问题

如何跳过测试驱动开发(TDD)?

在向AI提出请求时,加上 `--no-tdd` 参数即可。

这个Skill能用于非GitHub的代码仓库吗?

它主要设计为GitHub流程的自动伴侣,深度集成GitHub功能(如自动PR),在非GitHub仓库上功能可能受限。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/code-workflow/raw/index.md 读取 code-workflow 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。