Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 3.57 KB

AGENTS.md

File metadata and controls

38 lines (28 loc) · 3.57 KB

新手程序员 · Agent 工作约定

开始工作

阅读 工程文档、架构 和相关模块文档。网站内容在 content/,工程说明在 docs/,不要混用。旧 Astro 基线保存在 archive/astro-before-rebuild。

架构边界

  • 单应用 TanStack Start / React,Cloudflare Workers 运行服务端,D1 保存动态数据。
  • Bun 负责工具链;Workers 代码不得依赖 Bun API、文件系统或进程内持久状态。
  • 数据库、密钥和权限检查放在 src/server/,客户端只能通过服务端函数访问。
  • 服务端每次写入校验会话、输入、权限;不得相信前端管理员标记。
  • 内容稳定 ID 默认不随 URL 改变;2026-10-14 用户确认 fn 更名同步 project-fn / docs-fn-* 为本次例外,不迁移旧关联数据。生产构建不能包含草稿或私有数据。
  • 数据库采用提交到 Git 的增量迁移,禁止生产 schema push。
  • 当前使用 Cloudflare 免费套餐;不得自动升级或添加付费服务。公开内容优先由 Assets 提供,避免消耗动态请求额度;不配置付费版 CPU 上限。

质量标准

  • TypeScript strict;Oxlint 检查代码;Oxfmt 统一格式。不引入第二套 lint / format 工具链。
  • 使用 bun run fmt、bun run lint:fix 本地修复,提交前执行 bun run check、bun run test、bun run test:workers、bun run build。
  • 不关闭规则掩盖问题;局部禁用必须附具体理由。不手改生成文件。
  • 测试验证行为、权限和失败场景;修改接口时更新相应测试。

跨项目官网维护

  • 本站是个人网站,也是各自有项目统一的官网文档入口。内容按 content/projects/<project>/ 维护;包含 FIA、fn、agent-webtool 和本站自身;页面是否已上线以部署证据为准。修改前阅读 来源与同步规范,核对内容覆盖、相关源码契约及适用版本。
  • FIA 维护通用框架,fn 维护应用和 SDK,agent-webtool 维护网页抓取/搜索及 SDK/CLI/MCP,本站维护面向使用者的介绍与指南。可见行为、API/CLI、包名、平台或安装方式改变时,按来源记录核对内容;不在构建中读取外部 workspace,也不托管二进制。
  • 每次项目版本发布必须同步对应官网文档、安装入口、兼容说明和版本证据;缺少页面时补齐。若受公开产物、内容或部署条件阻塞,记录缺口和完成条件,不把源项目发版等同于官网已同步。
  • 区分本地实现、固定归档、公开 npm/Release 与网站上线状态。新发布需验证真实产物后再更新安装入口;未发布功能不得替代可复现的公开快照。相同版本号不是相同内容的证据。
  • main push 会触发预发布和生产部署,普通文档修改不自动授权推送或部署。工作区内还应维护根知识库;独立开发本站时本文件与工程文档仍可直接执行。

文档维护与完成标准

  • 每次变更根据 docs/impact.json 同步维护文档;无文档影响需在 PR 的 docs-impact: none — 原因 声明中解释。
  • bun run docs:generate 生成技术清单,bun run docs:check 检查链接与一致性。生成器只写 docs/generated.md。
  • 架构决策写 ADR;运行方式改变更新部署手册;本文件只记录长期规则,不追加开发日志。
  • 交付须说明变更、验证和外部阻塞;未验证的登录、部署、生产数据不得声称成功。
  • 不提交密钥、真实用户数据或测试会话。部署环境与 OAuth 应用分离。