Skip to content

development.md

Latest commit

 

History

History
133 lines (92 loc) · 2.06 KB

development.md

File metadata and controls

133 lines (92 loc) · 2.06 KB

💻 开发指南

Version

📋 环境准备

Node.js 环境

# Node.js 18+
node --version

# npm
npm --version

安装依赖

npm install

安装 OpenCode CLI

# Windows
npm install -g opencode-ai

# Linux/macOS
curl -fsSL https://opencode.ai/install | bash

🚀 开发模式

启动开发服务器

npm start

这将自动启动 OpenCode 后端 (如果需要) 并启动代理服务。

配置本地 config.json

cp config.json.example config.json

✅ 测试

命令 说明
npm test -- --runInBand 运行所有测试
npm run test:unit 运行单元测试
npm run test:integration 运行集成测试

Docker 测试

# 构建并运行
docker compose up -d --build

# 查看日志
docker compose logs -f

📝 代码规范

格式化

项目使用 ESLint (如有配置):

npm run lint

提交规范

使用 Conventional Commits:

feat: add new feature
fix: fix bug
docs: update documentation
refactor: refactor code
test: add tests
chore: update build/ci

📂 项目结构

OpenCode2API/
├── src/
│   └── proxy.js           # 核心代理逻辑
├── tests/
│   ├── app.test.js       # 单元测试
│   ├── test-integration.sh   # 集成测试
│   └── test-streaming-real.sh # 流式测试
├── docs/                 # 文档
├── index.js             # 入口文件
├── package.json         # 项目配置
├── Dockerfile           # Docker 镜像
└── docker-compose.yml   # Docker Compose

🔄 贡献流程

  1. ⭐ Fork 项目
  2. 🌿 创建功能分支: git checkout -b feature/your-feature
  3. 💾 提交更改: git commit -m 'feat: add new feature'
  4. 📤 推送分支: git push origin feature/your-feature
  5. 🔀 创建 Pull Request

📄 许可证

MIT License - 详见 LICENSE