code-workflow

一个遵循研究、计划、评审、实现四阶段编码工作流的GitHub助手。

安装使用

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

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

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

使用示例

‘请为Issue #42实现用户登录功能,使用coding workflow。’ 它会首先引导你研究相关代码和需求,然后协助你撰写详细的实现计划(plan.md),在计划获得确认后创建功能分支,接着遵循TDD步骤编写测试和代码,最后自动捕获界面变化并生成一个图文并茂的Pull Request。

介绍

这个Skill旨在解决开发者在GitHub仓库中进行代码变更时,流程不规范、上下文缺失和沟通低效的问题。它将代码变更过程结构化为四个清晰阶段:研究(了解背景)、计划(撰写方案)、用户评审(获取反馈)和实现(遵循TDD)。

使用时,你只需在GitHub仓库中提及它,并说明你的意图(如“coding workflow”或“write plan”),它便会引导你完成整个流程。它会自动生成计划文档、创建分支、协助TDD实现,并最终生成包含截图或录屏的PR描述。

它非常适合需要遵循严谨开发流程的团队或个人开发者,特别是那些重视代码质量、文档记录和团队协作的项目。对于全栈开发、后端开发或项目经理来说,它能有效统一团队的工作标准。

建议在开始新功能开发、修复复杂Bug或处理有明确Issue的任务时使用。注意,它深度集成GitHub工作流,主要适用于GitHub托管的项目。如果你习惯快速原型开发或不使用TDD,可以通过 --no-tdd 参数跳过测试驱动开发步骤。

核心特点

与通用的代码助手不同,它强制推行一个完整的、从研究到交付的四阶段工作流,并深度集成GitHub,能自动生成包含视觉证据(图片/GIF/视频)的PR,将过程文档化做到了极致。

注意事项

不适合需要快速原型验证或一次性脚本编写的轻量级、探索性编码任务。

常见问题

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

在指令中添加 `--no-tdd` 参数即可。

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

不能,它深度依赖GitHub的Issue、PR等原生功能,是GitHub-flow的自动伴侣。

给 AI 助手的安装指引

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

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