# opencode-paradigm

**Repository Path**: eastworld_zp/opencode-paradigm

## Basic Information

- **Project Name**: opencode-paradigm
- **Description**: AI agent自建工作流，具备需求规格生成、实施计划生成、tdd编码流程、代码review闭环能力
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-11
- **Last Updated**: 2026-05-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AI 团队工作流范式框架

> 基于 [OpenCode](https://opencode.ai/) 自建的工作流范式框架。需求规划、编码执行、代码评审三大核心环节均为自主编排，不依赖三方插件或外部服务。

---

## 设计理念

本框架将 AI 辅助编码的组织方式定义为 **工作流范式（Workflow Paradigm）**—— 不是零散的工具集合，而是一套可复制的团队协作流程：

- **规划驱动** — 先澄清需求，后动手编码，减少返工
- **测试先行** — TDD 内建质量，测试即文档
- **审查兜底** — 提交前自动化审查，守住安全与规范底线
- **零三方依赖** — 全部逻辑由 `commands/`（命令入口）、`agents/`（代理编排）、`skills/`（技能执行）、`rules/`（规则约束）四层自主实现

---

## 核心工作流

```
/hi-plan  →  /hi-tdd  →  /hi-code-review  →  提交
(规划)    (编码)      (审查)
```

| 阶段 | 命令 | 说明 |
|------|------|------|
| 需求规划 | `/hi-plan` | 需求澄清 → 规格文档 → 实施计划 |
| 编码执行 | `/hi-tdd` | 扫描 plan → 按 TDD 逐个实现 Task |
| 代码审查 | `/hi-code-review` | 安全审查 + 质量检查 + 规范校验 |
| 提交 | git commit | 代码入库 |

---

## 快速开始

### 集成到你的项目

```bash
# 复制工作流框架到项目根目录
cp -r /path/to/template/.opencode /your-project/
cp /path/to/template/opencode.json /your-project/
```

### 验证配置

```bash
# 在项目根目录启动 OpenCode
opencode

# 输入 /hi-guider 验证框架是否生效
```

如输出"工作流框架使用指南"菜单，说明配置生效。

---

## 快速上手

推荐使用 `/hi-guider` 智能体入门，它提供交互式学习菜单：

1. **新手上路** — 环境检查 + 第一个任务
2. **整体概述** — 工作流全貌与核心理念
3. **需求规划** — 如何清晰描述需求
4. **编码实现** — TDD 流程和构建修复
5. **代码审查** — 审查标准和提交流程
6. **规范文档** — 编码规范、安全底线等
7. **常见问题** — 使用中的疑惑解答
8. **框架设计** — 四层架构与扩展方式

---

## 更多资源

- **工作流规范**：[.opencode/rules/work-flow.md](./.opencode/rules/work-flow.md)
- **编码规范**：[.opencode/rules/code-style.md](.opencode/rules/code-style.md)
- **安全底线**：[.opencode/rules/code-security.md](.opencode/rules/code-security.md)
- **测试要求**：[.opencode/rules/testing.md](./.opencode/rules/testing.md)

## 补充说明
- **编码规范**：当前模板中rules/下code-style.md、code-security.md，真实环境需要替换为各自技术栈编码规范

---

## 作者

- **名称：** 小Z
- **邮箱：** happycodinger@163.com