code-workflow

一个遵循四阶段(研究、规划、评审、TDD实现)的代码变更自动化工作流

安装使用

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

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

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

使用示例

“我们需要实现用户登录的记住我功能,请使用code-workflow来规划并实施。” 它会首先引导你研究现有认证逻辑和最佳实践,然后协助撰写包含方案细节和潜在影响的 `plan.md` 文档。接着,它会建议你将计划分享给同事评审,并根据反馈创建功能分支,最后以TDD方式编写测试和实现代码,并自动生成附带演示截图的Pull Request。

介绍

这个Skill旨在解决开发者在处理代码变更、新功能开发或Issue修复时,工作流程不规范、步骤遗漏、文档缺失和测试不充分的问题。它将一次代码变更分解为四个清晰阶段:研究(Step 0-1)、规划(Step 2)、用户评审(Step 3)和测试驱动开发实现(Step 4),并自动引导用户完成每个步骤,最终生成包含截图/GIF/视频的PR描述。

使用时,你只需在合适的上下文中(如讨论代码变更、新功能或Issue)激活该Skill,它会引导你逐步完成从背景研究、方案规划、获取反馈到最终代码实现的全过程。它会自动生成规划文档(plan.md),协助创建分支,并在实现阶段默认采用TDD方式,确保代码质量。

它非常适合需要遵循严谨开发流程的团队或个人开发者,特别是那些在GitHub上进行协作、希望提升代码审查质量和项目可追溯性的项目。对于全栈开发、后端开发、前端开发以及负责代码质量的工程师来说,这是一个极佳的工具。

建议在开始任何非琐碎的代码修改前使用此Skill,以确保思考的全面性。注意,其默认强制TDD,如果希望跳过测试,需在指令中明确添加 --no-tdd 参数。它深度集成GitHub流程,最适合在GitHub仓库的上下文中使用。

核心特点

与其它通用编码助手或单点工具不同,它强制推行一个完整的、阶段化的“研究-规划-评审-实现”工作流闭环,并默认集成TDD,而非仅仅提供代码补全或片段生成。其核心在于流程规范化和文档自动化,最终产出的是结构化的PR,而不仅仅是代码。

注意事项

不适合需要快速原型验证、紧急线上问题修复或非常简单的单行代码修改等追求速度优先的场景。

常见问题

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

在启动工作流或相关指令时,添加 `--no-tdd` 参数即可跳过TDD步骤。

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

它主要设计为GitHub-flow的自动伴侣,深度集成GitHub功能(如PR生成),在非GitHub环境下的功能可能受限。

给 AI 助手的安装指引

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

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