JenkenB
dfd567fe2c
Introduce a new detailed Agent handbook (docs/【协作规范】Agent工作入口与执行准则-2026-06-22.md) and refactor AGENTS.md to be an entry-only navigation page. Update documentation cross-references (docs/README.md, project-memory README, document-map, team-conventions, development-workflow, decision-log and project-overview) to point to the new file and clarify reading/order rules, submission/validation constraints, and SpacetimeDB/back-end wording. Also adjust image canvas generation placement rules in the frontend doc and apply related changes to image-editor hooks/tests (src/components/image-editor/*). Purpose: separate high-level entry rules from complex execution details to reduce startup cost for complex tasks and centralize execution practices in a single guideline document.
4.0 KiB
4.0 KiB
团队协作约定
用途：约定 3 名开发人员在各自本地开发环境和 Agent 中协作开发、共享项目记忆的方式。
基本模式
- 每位开发人员在自己的电脑上使用本地 Agent。
- 每位开发人员本地拉取同一个项目仓库，独立修改代码、运行测试、提交分支。
- 团队共享内容优先放在本仓库
docs/project-memory/与docs/中，通过 Git 同步。 - 不共享个人
~/.hermes目录。
共享与禁止共享
推荐共享：
docs/project-memory/shared-memory/团队级长期记忆docs/project-memory/plans/阶段性实施计划docs/project-memory/todos/已确定需要执行、但尚未进入实施的共享 TODO 计划.hermes/skills/Hermes 专用仓库级 skillsdocs/中 PRD、设计、技术、经验、审计、查询手册AGENTS.md项目级 Agent 约束docs/【协作规范】Agent工作入口与执行准则-2026-06-22.mdAgent 执行细则
禁止提交：
- 个人
~/.hermes/config.yaml - 个人
~/.hermes/.env - 个人
~/.hermes/sessions/ - API Key、Token、Cookie、认证文件
- 个人本地私密路径和个人隐私信息
- 构建产物、日志、缓存、数据库 dump
开发前
- 拉取最新代码。
- 阅读
AGENTS.md。 - 复杂任务阅读
docs/【协作规范】Agent工作入口与执行准则-2026-06-22.md。 - 阅读
docs/project-memory/shared-memory/中与任务相关的文件。 - 阅读
docs/README.md和任务相关分类 README。 - 阅读对应 PRD、设计、技术、经验或审计文档。
- 如果文档不足以指导编码，先补充或修正文档。
开发中
- 保持修改范围聚焦，不做无关重构。
- 复用、修改、扩展现有系统优先，避免新建重复系统或页面。
- 新增 Markdown 文档时，文件名必须以分类标签开头，格式为
【标签名】中文标题-日期.md；只在任务需要时重命名历史文档，避免无关大 diff。 - 涉及中文文本时注意 UTF-8 编码和乱码排查。
- 涉及后端时遵循 DDD 分层，不把业务真相下沉到前端或临时兼容层。
maincloud/Maincloud/MAINCLOUD相关代码、脚本、测试、环境变量、命令和文档要求均视为历史残留，禁止新增、运行或引用；API smoke 统一使用npm run dev:api-server与/healthz。- 涉及 SpacetimeDB 表结构、发布或迁移时，先看
SPACETIMEDB_SCHEMA_CHANGE_CONSTRAINTS.md和SPACETIMEDB_TABLE_CATALOG.md。 - 涉及生产发布、服务器配置、Jenkins Job 重建或回滚时，先看
PRODUCTION_DEPLOYMENT_PLAN_2026-05-02.md。
开发后
- 运行与修改范围匹配的测试或验证命令。
- 更新相关
docs/文档。 - 新增或沉淀 Markdown 文档时，确认文件名已使用
【标签名】前缀。 - 若产生长期有效知识，更新
docs/project-memory/shared-memory/。 - 若形成 Hermes 专用可复用流程，考虑沉淀到
.hermes/skills/。 - 提交代码时，提交标题使用中文；标题后逐行写明本次提交修改了什么，每条变更单独一行。
文档阅读顺序
通用任务建议：
README.mdAGENTS.mddocs/【协作规范】Agent工作入口与执行准则-2026-06-22.mddocs/project-memory/shared-memory/docs/README.md- 任务所属分类：
docs/design/、docs/technical/、docs/planning/、docs/prd/、docs/reference/、docs/tracking/、docs/operations/
后端任务建议：
docs/【后端架构】server-rs与SpacetimeDB数据契约-2026-05-15.mddocs/【开发运维】本地开发验证与生产运维-2026-05-15.md- 任务相关 crate README、源码和当前专题文档
共享记忆更新准则
适合更新：
- 新增稳定架构约定
- 新增长期开发流程
- 已验证的踩坑和排障步骤
- 重要接口契约变化
- 团队协作规范变化
- 文档索引或阅读顺序变化
不适合更新：
- 一次性临时计划
- 未验证猜测
- 个人偏好和个人路径
- 敏感信息
- 大段聊天记录