2.7 KiB
2.7 KiB
AGENTS.md
给 AI 协作者的仓库指引。开始任何工作前,先读 README.md——它是全景入口:项目是什么、为什么长这样、走到哪了。
协作约定(长期有效)
- Git:仅当项目作者明确说"提交 / commit"时才执行提交;
git push永远由项目作者手工执行,AI 绝不推送 - 命名:需求 / 设计 / 交互 / 技术 / 计划等文档名用中文(
README/AGENTS/LICENSE等约定俗成除外)、目录用英文;新文档按性质放入docs/design/(我们定的方案与决策)或docs/references/(平台可用接口参考——实证事实,不做设计决策),并同步更新 README 的「文档地图」;docs/deprecated/只归档已废弃文档——勿引用、勿作依据(本分支暂无此目录,需要时再建) - 文档状态:头部表格标「状态」(草案 → 讨论中 → 待审阅 → 定稿(日期) → 已实现);设计文档定稿后不搬家、只改状态;被取代时删除(git 历史即考古)
- 部署:交付物必须保证「一条命令链」可部署;双形态并行已裁决——完整前后端(运营方服务器)先行,Cloudflare Workers 抽取版(作者自部署)后续(见
docs/design/需求清单.mdR13) - 不引入版本叙事:不使用 v1/v2/v3 之类版本编号,不以「MVP」等标签或指称显式描述任何历史阶段;文档内容必须自立——不得引用、描述任何当前分支之外、可能被删除的分支内容
项目速览(速记)
design(本分支)= 设计文档中心 + 实现主线:实现代码与文档同分支演进(代码落点已定案),monorepo 结构(apps/server·apps/web·packages/core·packages/db)见docs/design/技术选型.md§4- 数据模型:四张基线表(
api_keys·usage_logs·payments·qpu_history)+ 三张访问主体表(members·users·sessions)设计见本目录,七篇已定稿(2026-10-01,经作者逐篇审阅);同步架构(轮询 +request_id去重 + 攒库)的动因由上游物理约束决定,架构结论不变 - 需求总集与待裁决项(平台身份体系、费用分摊与账单、充值折算、多订阅、数据资产保护)见
docs/design/需求清单.md;交付形态已裁决(双形态并行,完整形态先行) - 上游约束速记:只有 sk-key、无时间过滤接口 → 轮询攒库是唯一路径(README「架构的根本动因」)
命令
实现骨架尚未搭建,暂无构建 / 测试命令;骨架落地后在此登记(Bun 工具链,选型见 docs/design/技术选型.md)。