gongzhiyong
2a6a709f58
Add a complete docs skeleton for onboarding and integration, including orchestration-plan contract, acceptance matrix, OAuth flow, architecture maps, and milestone status tracking to support Agnet-facing delivery work. Made-with: Cursor
2.4 KiB
2.4 KiB
新成员上手指引
适合刚加入 Heicode 项目的研发同学：把环境跑起来 → 认识仓库结构 → 知道改哪、看哪。
推荐阅读顺序
local-dev.md：把cc-haha（客户端）、new-api（Manager）、website（站点）跑起来；含常见错误与排查env-variables.md：客户端识别的环境变量（base URL、OAuth 配置）- 共用骨架：
../architecture.md、../glossary.md、../sk-lifecycle.md - 现状对齐：
../milestones/STATUS.md - 子项目细则：
- 客户端约定：
../../cc-haha/AGENTS.md - 网关约定：
../../new-api/CLAUDE.md
- 客户端约定：
改代码前的最小心智模型
| 你要改什么 | 入口文件 | 备注 |
|---|---|---|
| 客户端登录 / Provider | cc-haha/src/server/api/heicode-auth.ts |
路由前缀 /api/heicode-auth/* |
| 客户端模型发现 | cc-haha/src/server/services/providerService.ts、cc-haha/src/server/api/providers.ts |
/v1/models 探活 |
| Provider 预设 | cc-haha/src/server/config/providerPresets.json + providerPresets.ts |
仅保留 taijiaicloud / clawdrouter |
| Manager OAuth | new-api/controller/heicode_oauth.go |
路由 new-api/router/heicode-router.go |
| 桌面端 UI | cc-haha/desktop/src/ |
Tauri + React |
你不需要做的事
- 不要 在 Heicode 客户端里实现计费 / 订阅；这部分归 Manager 与平台
- 不要 给 Agnet 平台或 Manager 增加可写 SK 正文的 API（违反 SK 边界，详见
../sk-lifecycle.md） - 不要 引入「客户端 → 模型供应商直连」的捷径；所有模型调用应经 Manager 路由
提交与协作
- 提交风格沿用 Conventional Commits：
feat:/fix:/docs:/chore:等 - 分支前缀：
feat/*、fix/*、docs/*（不要新建codex/*） - PR 描述列出影响面、验证步骤；UI 改动附截图
- 文档与代码同 PR 提交：避免事后再补 docs
提问与求助
- 客户端 TS/React 行为问题：先看
../../cc-haha/AGENTS.md - 网关 Go 行为问题：先看
../../new-api/CLAUDE.md - 集成 / Agnet 契约问题：先看
../integration/README.md