module3
30 分钟

实战:搭建个人开发工作流

学习进度

当前模块0/6 课
总进度0/36 课
学习时长0 分钟

学习目标

  • 搭建 code → review → test → commit 端到端流水线
  • 配置一键启动的开发环境
  • 编写个人化的 Codex 自定义指令
  • 量化效率提升并输出个人工作流文档

206 实战:搭建个人开发工作流

将审查、测试、提交串联为端到端流水线,打造一键式个人开发环境

学习目标

一、端到端开发流水线

完整流程串联

#!/bin/bash
# scripts/dev-pipeline.sh — 个人开发流水线

echo "🚀 启动开发流水线..."

# 1. 代码生成/修改
codex edit "实现用户导出功能,支持 CSV 和 Excel 格式"

# 2. 自动审查
codex review --fail-on critical

# 3. 自动测试
codex test --changed --coverage --threshold 80

# 4. 提交代码
codex commit

# 5. 推送并创建 PR
codex pr --base main

echo "✅ 流水线完成!"

使用方式

# 赋予执行权限
chmod +x scripts/dev-pipeline.sh

# 直接运行
./scripts/dev-pipeline.sh
**💡 提示:** 将流水线脚本绑定到快捷键或 IDE 任务,实现真正的一键操作。

二、一键开发环境搭建

环境初始化脚本

#!/bin/bash
# scripts/setup.sh — 新项目初始化

# 克隆项目
git clone git@github.com:team/project.git
cd project

# 安装依赖
npm install

# Codex 环境初始化
codex init --auto

# 安装 Git Hooks
codex hook install pre-commit
codex hook install commit-msg

# 生成项目文档
codex docs --type readme --output README.md

# 验证环境
codex doctor

echo "🎉 开发环境就绪!"

`codex init --auto` 自动配置内容

  • 检测项目语言、框架和工具链
  • 生成 `.codex/review.yaml` 审查规则
  • 生成 `.codex/hooks.yaml` Hook 配置
  • 创建团队共享的 `.codex/instructions.md`

三、自定义 Codex 指令

项目级指令文件

`.codex/instructions.md`:

# 本项目 Codex 指令

## 代码风格
- 使用 2 空格缩进
- 函数名使用 camelCase,组件名使用 PascalCase
- 每个文件不超过 300 行

## 测试要求
- 所有公开 API 必须有单元测试
- 集成测试覆盖关键业务路径
- 测试文件与源文件同目录,命名为 *.test.ts

## Git 规范
- 使用 Conventional Commits
- 分支命名:feat/* fix/* refactor/* docs/*
- PR 必须关联 Issue

## 常用命令
- 审查:codex review --fail-on critical
- 测试:codex test --changed --coverage
- 提交:codex commit

个人偏好配置

# 设置个人偏好
codex config set review.auto-fix true
codex config set commit.sign-off true
codex config set test.coverage-threshold 85

四、量化效率提升

效率数据采集

# 开启效率统计
codex analytics --enable

# 查看周报
codex analytics --report weekly

Codex 自动统计的指标:

指标说明
日均审查次数衡量代码质量活动频率
问题检出率Critical/Warning/Suggestion 分布
测试覆盖率趋势项目质量走势
提交信息合规率Conventional Commits 采用情况
流水线通过率CI 稳定性和效率

效率对比模板

环节手动耗时Codex 辅助节省
代码审查15 分钟2 分钟87%
写测试30 分钟5 分钟83%
写提交信息2 分钟10 秒92%
PR 描述10 分钟1 分钟90%

五、个人工作流文档模板

文档结构

# 我的开发工作流 v1.0

## 工具链
- IDE: VS Code + Codex CLI v2.0
- 语言: TypeScript 5.x
- 框架: Next.js 14

## 日常工作流
1. 上午站会后拉取最新代码
2. 使用 `codex edit` 开始新功能开发
3. 提交前:`./scripts/dev-pipeline.sh`
4. 创建 PR 并关联 Issue

## 快捷键
- Cmd+Shift+R: 运行审查
- Cmd+Shift+T: 运行测试
- Cmd+Shift+C: 生成提交

## 效率数据(最近 30 天)
- 平均开发周期:2.3 天/功能
- 代码审查时间:平均 3 分钟
- Bug 检出率:提升 40%

六、本课总结

**核心要点:**

  • 端到端流水线将审查、测试、提交流程串联为一键操作
  • `codex init --auto` 快速初始化标准化项目环境
  • `.codex/instructions.md` 确保团队和个人的工作习惯一致
  • `codex analytics` 量化效率提升,数据驱动改进
  • 个人工作流文档帮助持续优化和知识传承

**下一步:** 进入模块 4,探索内容与数据工作流 → [301 技术文档撰写](module4-301.md)

上一课
下一模块