tdd-workflow

Files (2)

• SKILL.md
• openai.yaml · agents/

SKILL.md (first lines)

# 测试驱动开发工作流

此技能确保所有代码开发遵循 TDD 原则和全面的测试覆盖。

## 何时激活

- 编写新功能或功能
- 修复错误或问题
- 重构现有代码
- 添加 API 端点
- 创建新组件

## 核心原则

### 1. 测试先于代码
始终先编写测试，然后实现代码以使测试通过。

### 2. 覆盖要求
- 最低 80% 覆盖率（单元 + 集成 + E2E）
- 覆盖所有边缘情况
- 测试错误场景
- 验证边界条件

### 3. 测试类型

#### 单元测试
- 单个函数和工具
- 组件逻辑
- 纯函数
- 助手和工具

#### 集成测试
- API 端点
- 数据库操作
- 服务交互
- 外部 API 调用

#### E2E 测试（Playwright）
- 关键用户流程
- 完整工作流
- 浏览器自动化
- UI 交互

## TDD 工作流程步骤

### 步骤 1：编写用户旅程
```
作为 [角色]，我想要 [操作]，以便 [利益]

示例：
作为用户，我想要语义搜索市场，
以便即使没有确切的关键词也能找到相关市场。
```

### 步骤 2：生成测试用例
为每个用户旅程创建全面的测试用例：

```typescript
describe('语义搜索', () => {
  it('为查询返回相关市场', async () => {
    // 测试实现
  })

  it('优雅处理空查询', async () => {
    // 测试边缘情况
  })

  it('当 Redis 不可用时回退到子字符串搜索', async () => {
    // 测试回退行为
  })

  it('按相似度分数对结果排序', async () => {
    // 测试排序逻辑
  })
})
```

### 步骤 3：运行测试（它们应该失败）
```bash
npm test
# 测试应该失败 — 我们尚未实现
```

### 步骤 4：实现代码
编写使测试通过的最少代码：

```typescript
// 测试指导的实现
export async function searchMarkets(query: string) {
  // 实现这里
}
```

### 步骤 5：再次运行测试
```bash
npm test
# 测试现在应该通过
```

### 步骤 6：重构
在保持测试绿色的同时提高代码质量：
- 删除重复
- 改进命名
- 优化性能
- 增强可读性

### 步骤 7：验证覆盖率
```bash
npm run test:coverage
# 验证实现 80%+ 覆盖率
```

## 测试模式

### 单元测试模式（Jest/Vitest）
```typescript
import { render, screen, fireEvent } from '@testing-library/react'
import { Button } from './Button'

From aaione/everything-claude-code-zh, MIT.

More from aaione/everything-claude-code-zh