# Codex · 工作流总结


> CI/CD：持续集成和持续交付==实现软件发布流程各个阶段（从开发到部署）自动化的方法
>
> PR：Pull Request==拉取请求，开发者可以将自己完成的代码修改提交给代码库的维护者，申请将这些更改合并到目标分支中

## CI/CD工作

* 自动更新CHANGELOG：每次合并主分支后自动根据提交记录更新 CHANGELOG.md（合并到 main 分支后）
* 生成API文档： 根据代码变更自动生成或同步 API 文档（代码推送后）
* 自动代码审查：在 PR 流水线里自动跑代码审查并留下注释（PR创建或更新时）

## 日常开发工作流

### 步骤

1.  明确需求： 描述你想要实现的功能
2. Codex分析：Codex 理解项目结构和规范
3. 方案讨论： 与 Codex 确认实现方案
4. 代码生成：Codex 编写代码并修改文件
5. 验证测试：运行测试确认功能正确
6. 迭代优化： 根据反馈调整代码

## 代码理解工作流

### 步骤

1. 从入口点开始，让 Codex 解释整体架构
2. 逐步深入关键模块，理解核心逻辑
3. 追踪数据流和调用链
4. 总结关键点和注意事项

### 快速上手新代码(待总结)

```

```

## 重构工作流

> 谨慎使用，系统性改进代码结构

1. 先理解现有代码结构
2. 小步重构，逐步改进
3. 每步验证，确保功能不变
4. 保持测试覆盖

## Bug修复工作流

```
# 描述问题
"用户登录时偶尔出现 500 错误，错误日志显示：
TypeError: Cannot read property 'id' of undefined"

# 提供信息
"这是完整的错误堆栈：[粘贴堆栈信息]"

# 定位根因
Codex 分析后发现问题：用户对象在某些情况下为 null

# 生成修复
"修复这个问题，并确保不会影响正常登录流程"

# 验证修复
"运行登录相关的所有测试"

# 防止复发
"添加一个测试覆盖用户对象为 null 的场景"
```

## 代码审查工作流 

### 审查模式

* Review Mode：审查本地未提交变更
* /review：审查指定范围变更
* Github集成：审查PR

### 本地审查方法

```
# App 中启用 Review Mode
点击工具栏的眼睛图标

# 或在 CLI 中使用
/review

# 指定审查范围
/review src/auth/

# 审查特定提交
/review HEAD~3..HEAD
```

### 审查重点指定

```
# 安全审查
/review for security issues

# 性能审查
/review for performance regressions

# 代码风格
/review for code style consistency

# 综合审查
/review --detailed
```

## 测试编写工作流

### 新功能

```
# 为新功能编写测试
"为 src/api/users.py 的 GET 端点编写单元测试，
覆盖正常响应、空列表、分页边界等场景"

# 验证测试
"运行新编写的测试"

# 补充覆盖
"检查测试覆盖率，补充未覆盖的边界情况"
```

### 测试修复

```
# 分析失败测试
"测试 test_user_login 失败了，分析原因并修复"

# 批量修复
"运行所有测试，修复失败的测试"
```



---

> Author: [Ting](Tin10g.github.io)  
> URL: http://localhost:1313/posts/codex-%E5%B7%A5%E4%BD%9C%E6%B5%81%E6%80%BB%E7%BB%93/