- 如果 package 更新新特性和用户使用相关, 则需要 更新 homepage 当中的 docs。
- 模块最多800-1000行,超过之后拆分成多个模块。
- 尽量不要使用动态导入
- 每个模块都应该写详细的文档注释。
- 关键节点所有的注释都使用中文
- 类型统一放到 types/ 下面
- package 对外能力、SDK API、用户可见行为发生变化并准备提交时,必须使用 patch 脚本完成版本号自增与构建:
- 只改
@downcity/agent:pnpm agent:patch:build - 只改
@downcity/city:pnpm city:patch:build - 多 package 联动:
pnpm all:patch:build - 仅验证不需要 bump 时才允许使用
pnpm patch:build -- --no-bump ...
- 只改
- commit 前先确认改动范围,只 stage 本次任务相关文件,不要混入用户未要求的改动。
- 如果属于 package 用户可见更新,先运行对应 patch 脚本,再补跑受影响区域的 typecheck / lint。
- patch 脚本通过后再
git add、git commit,commit message 使用明确作用域,例如feat(agent): add session system prompts api。 - commit 完成后用
git status --short确认没有遗漏本次任务应提交的文件。
- 仅面向用户写文档,不需要写开发文档,开发文档在 docs 中
- 永远不要考虑向后兼容,直接迭代。保证功能一致,采用做合适的实践。
- 保证最简 + 最佳实践
- 所有的模块必须添加文件注释/模块注释
- 你在创建任何 type 类型的时候,都需要每个字段都给到详细的注释说明。