Files
Genarrative/.hermes/shared-memory/team-conventions.md
高物 3cb3efb4d0 Prune stale docs and update .hermes content
Delete a large set of outdated documentation (many files under docs/ and .hermes/plans/, including audits, design, prd, technical, planning, assets, and todos). Update and consolidate .hermes content: refresh shared-memory pages (decision-log, development-workflow, document-map, pitfalls, project-overview, team-conventions) and several skills/references under .hermes/skills. Also modify AGENTS.md, README.md, UI_CODING_STANDARD.md, docs/README.md and .encoding-check-ignore. Purpose: clean up stale planning/audit material and keep current hermes documentation and related top-level docs in sync.
2026-05-15 06:24:07 +08:00

2.6 KiB

团队协作约定

更新时间:2026-05-15

基本模式

  • 每位开发人员在自己的电脑上使用本地 Hermes。
  • 团队共享内容放在仓库 .hermes/docs/ 中,通过 Git 同步。
  • 不共享个人 ~/.hermes 目录、密钥、会话、Token、Cookie、认证文件、本地私密路径或构建产物。

开发前

  1. 拉取最新代码。
  2. 阅读 AGENTS.md
  3. 阅读 .hermes/shared-memory/ 中与任务相关的文件。
  4. 阅读 docs/README.md 和 4 份当前融合文档中与任务相关的部分。
  5. 如果文档不足以指导编码,先补充或修正文档。

当前文档入口:

  • docs/【项目基线】当前产品与工程约束-2026-05-15.md
  • docs/【后端架构】server-rs与SpacetimeDB数据契约-2026-05-15.md
  • docs/【玩法创作】平台入口与玩法链路-2026-05-15.md
  • docs/【开发运维】本地开发验证与生产运维-2026-05-15.md

开发中

  • 保持修改范围聚焦,不做无关重构。
  • 优先复用、修改、扩展现有系统、页面、组件和弹层。
  • 新增 Markdown 文档时,文件名必须以分类标签开头,格式为 【标签名】中文标题-YYYY-MM-DD.md
  • 阶段性计划、一次性 TODO 和已关闭实验不要长期沉淀为仓库文档;仍有效内容合并进当前 docs/.hermes/shared-memory/
  • 涉及中文文本时注意 UTF-8 编码和乱码排查。
  • 涉及后端时遵循 DDD 分层,不把业务真相下沉到前端或临时兼容层。
  • maincloud / Maincloud / MAINCLOUD 相关代码、脚本、测试、环境变量、命令和文档要求均视为历史残留,禁止新增、运行或引用。
  • API smoke 统一使用 npm run api-server/healthz
  • 涉及 SpacetimeDB 表结构、发布或迁移时,先看当前后端架构文档的 schema 变更规则和表目录。
  • 涉及生产发布、服务器配置、Jenkins Job 重建或回滚时,先看当前开发运维文档。

开发后

  1. 运行与修改范围匹配的测试或验证命令。
  2. 更新相关 docs/ 当前文档。
  3. 若产生长期有效知识,更新 .hermes/shared-memory/
  4. 若形成可复用流程,考虑沉淀到 .hermes/skills/
  5. 提交信息区分代码变更、文档变更和共享记忆变更。

共享记忆更新准则

适合更新:

  • 稳定架构约定。
  • 长期开发流程。
  • 已验证的踩坑和排障步骤。
  • 重要接口契约变化。
  • 团队协作规范变化。
  • 当前文档索引或阅读顺序变化。

不适合更新:

  • 一次性临时计划。
  • 未验证猜测。
  • 个人偏好和个人路径。
  • 敏感信息。
  • 大段聊天记录。