98 lines
3.5 KiB
Markdown
98 lines
3.5 KiB
Markdown
# 团队协作约定
|
||
|
||
> 用途：约定 3 名开发人员在各自本地 Hermes 中协作开发、共享项目记忆的方式。
|
||
|
||
## 基本模式
|
||
|
||
- 每位开发人员在自己的电脑上使用本地 Hermes。
|
||
- 每位开发人员本地拉取同一个项目仓库，独立修改代码、运行测试、提交分支。
|
||
- 团队共享内容优先放在本仓库 `.hermes/` 与 `docs/` 中，通过 Git 同步。
|
||
- 不共享个人 `~/.hermes` 目录。
|
||
|
||
## 共享与禁止共享
|
||
|
||
推荐共享：
|
||
|
||
- `.hermes/shared-memory/` 团队级长期记忆
|
||
- `.hermes/plans/` 阶段性实施计划
|
||
- `.hermes/skills/` 未来可复用仓库级 skills
|
||
- `docs/` 中 PRD、设计、技术、经验、审计、查询手册
|
||
- `AGENTS.md` 项目级 Agent 约束
|
||
|
||
禁止提交：
|
||
|
||
- 个人 `~/.hermes/config.yaml`
|
||
- 个人 `~/.hermes/.env`
|
||
- 个人 `~/.hermes/sessions/`
|
||
- API Key、Token、Cookie、认证文件
|
||
- 个人本地私密路径和个人隐私信息
|
||
- 构建产物、日志、缓存、数据库 dump
|
||
|
||
## 开发前
|
||
|
||
1. 拉取最新代码。
|
||
2. 阅读 `AGENTS.md`。
|
||
3. 阅读 `.hermes/shared-memory/` 中与任务相关的文件。
|
||
4. 阅读 `docs/README.md` 和任务相关分类 README。
|
||
5. 阅读对应 PRD、设计、技术、经验或审计文档。
|
||
6. 如果文档不足以指导编码，先补充或修正文档。
|
||
|
||
## 开发中
|
||
|
||
- 保持修改范围聚焦，不做无关重构。
|
||
- 复用、修改、扩展现有系统优先，避免新建重复系统或页面。
|
||
- 涉及中文文本时注意 UTF-8 编码和乱码排查。
|
||
- 涉及后端时遵循 DDD 分层，不把业务真相下沉到前端或临时兼容层。
|
||
- `maincloud` / `Maincloud` / `MAINCLOUD` 相关代码、脚本、测试、环境变量、命令和文档要求均视为历史残留，禁止新增、运行或引用；API smoke 统一使用 `npm run api-server` 与 `/healthz`。
|
||
- 涉及 SpacetimeDB 表结构、发布或迁移时，先看 `SPACETIMEDB_SCHEMA_CHANGE_CONSTRAINTS.md` 和 `SPACETIMEDB_TABLE_CATALOG.md`。
|
||
- 涉及生产发布、服务器配置、Jenkins Job 重建或回滚时，先看 `PRODUCTION_DEPLOYMENT_PLAN_2026-05-02.md`。
|
||
|
||
## 开发后
|
||
|
||
1. 运行与修改范围匹配的测试或验证命令。
|
||
2. 更新相关 `docs/` 文档。
|
||
3. 若产生长期有效知识，更新 `.hermes/shared-memory/`。
|
||
4. 若形成可复用流程，考虑沉淀到 `.hermes/skills/`。
|
||
5. 在提交信息中区分代码变更与文档/记忆变更。
|
||
|
||
## 文档阅读顺序
|
||
|
||
通用任务建议：
|
||
|
||
1. `README.md`
|
||
2. `AGENTS.md`
|
||
3. `.hermes/shared-memory/`
|
||
4. `docs/README.md`
|
||
5. `docs/experience/README.md`
|
||
6. `docs/audits/README.md`
|
||
7. 任务所属分类：`docs/design/`、`docs/technical/`、`docs/planning/`、`docs/prd/`、`docs/reference/`、`docs/tracking/`、`docs/operations/`
|
||
|
||
后端任务建议：
|
||
|
||
1. `docs/technical/CURRENT_BACKEND_IMPLEMENTATION_BASELINE_2026-04-25.md`
|
||
2. `docs/technical/SERVER_RS_DDD_FULL_REFACTOR_2026-04-28.md`
|
||
3. `docs/technical/SERVER_RS_DDD_G1_CONTRACT_AND_ROUTE_MATRIX_2026-04-29.md`
|
||
4. `docs/technical/SERVER_RS_DDD_PARALLEL_TASKLIST_2026-04-29.md`
|
||
5. `docs/technical/SPACETIMEDB_SCHEMA_CHANGE_CONSTRAINTS.md`
|
||
6. `docs/technical/SPACETIMEDB_TABLE_CATALOG.md`
|
||
7. `docs/technical/MAINCLOUD_REFERENCE_REMOVAL_POLICY_2026-05-06.md`
|
||
|
||
## 共享记忆更新准则
|
||
|
||
适合更新：
|
||
|
||
- 新增稳定架构约定
|
||
- 新增长期开发流程
|
||
- 已验证的踩坑和排障步骤
|
||
- 重要接口契约变化
|
||
- 团队协作规范变化
|
||
- 文档索引或阅读顺序变化
|
||
|
||
不适合更新：
|
||
|
||
- 一次性临时计划
|
||
- 未验证猜测
|
||
- 个人偏好和个人路径
|
||
- 敏感信息
|
||
- 大段聊天记录
|