Codex 任务模板库
从零开始掌握 OpenAI Codex——AI 编程工程 Agent。14 章覆盖认识 Codex、四种入口安装、核心功能(自动化/插件/Skill/MCP/Git/记忆)、标准工作流、实战案例和第三方模型接入。
一句话结论
任务模板库是 Codex 提效的关键:修 bug、加功能、写测试、重构、写文档、读项目都有标准模板可以直接复用。
Codex 任务模板库
前面讲的是 Codex 的标准工作流。
这一节直接放一些常用模板,方便以后复制使用。
这些模板的作用是:
不用每次重新想 Prompt,直接按场景复制,然后填入自己的需求。
读项目模板
这个模板适合在刚打开一个新项目时使用。
尤其是你第一次让 Codex 接触某个项目,不要一上来就让它改代码。
更稳的方式是:先让它读项目,输出一份项目理解报告。
这样你可以先判断:
| 检查点 | 作用 |
|---|---|
| Codex 是否看懂项目 | 防止一上来改错文件 |
| 技术栈是否判断正确 | 确认它知道项目用的是什么框架 |
| 启动方式是否清楚 | 后面测试和运行更顺 |
| 核心模块是否找对 | 后续修改不会乱找方向 |
| 风险是否提前暴露 | 避免误改核心逻辑 |
读项目模板(可直接复制)
[code]
请先不要修改任何代码。
请阅读当前项目,并输出一份项目理解报告,包括:
1. 技术栈
- 项目使用了哪些主要技术
- 前端/后端/数据库/构建工具分别是什么
- 是否使用 TypeScript、Tailwind、框架或组件库
2. 目录结构
- 主要目录分别负责什么
- 页面、组件、工具函数、接口、配置文件分别在哪里
- 哪些目录是核心目录,哪些目录不建议随便改
3. 启动方式
- 项目如何安装依赖
- 项目如何本地启动
- 是否需要环境变量
- 如果 README 里有说明,请优先参考 README
4. 测试命令
- 项目是否有 test 命令
- 是否有 lint 命令
- 是否有 typecheck 命令
- 是否有 build 命令
- 如果没有相关命令,请明确说明
5. 核心模块
- 项目的核心功能模块有哪些
- 每个模块大概负责什么
- 如果后续要修改功能,应该优先查看哪些文件
6. 后续修改风险
- 哪些文件或目录改动风险较高
- 哪些逻辑不能随便改
- 是否存在全局样式、全局配置、鉴权、接口、数据库等高风险区域
- 后续修改时需要特别注意什么
请只输出项目理解报告,不要修改代码。
输出完成后等待我确认。
[/code]
修 Bug 模板
我遇到一个 bug:
- 【现象】
- 【复现步骤】
- 【期望结果】
- 【实际结果】
- 【相关文件/页面】
请先定位原因,不要直接修改。
先给出:
- 可能原因
- 需要查看的文件
- 修复方案
- 风险点 等我确认后再改代码。
加功能模板
我想新增一个功能:
- 【功能描述】
- 【入口位置】
- 【交互流程】
- 【视觉要求】
- 【数据来源】
- 【验收标准】
请先阅读相关代码,给出实现计划。
不要改无关文件。
实现后请运行测试并总结 diff。
前端页面模板
请根据下面要求实现一个页面:
- 【页面用途】
- 【目标用户】
- 【视觉风格】
- 【模块结构】
- 【中文文案】
- 【响应式要求】
- 【不要出现的问题】
请先给出组件拆分方案,再开始实现。
代码审查模板
请审查当前分支相对 main 的 diff。
重点检查:
- 潜在 bug
- 边界条件
- 安全风险
- 类型问题
- 性能问题
- 是否有无关修改
- 测试是否充分 请不要直接修改代码,先输出 review 报告。
重构模板
请重构以下模块:
【模块路径】
目标是:
- 提高可读性
- 减少重复代码
- 保持现有行为不变
- 不改变公共 API
- 不引入新依赖 请先写重构计划,并说明如何验证行为一致。
写测试模板
请为以下功能补充测试:
- 【功能描述】
- 【相关文件】
- 【边界情况】
要求:
- 不改业务逻辑
- 覆盖正常路径
- 覆盖异常路径
- 覆盖边界条件
- 运行测试并报告结果。
写文档模板
请根据当前项目生成文档:
- 项目简介
- 安装方式
- 启动方式
- 环境变量说明
- 常用命令
- 目录结构
- 开发注意事项
- 常见问题 请不要编造不存在的命令,必须基于项目文件判断。