| name | hai-framework-sync |
| description | 管理 hai-framework 与应用仓库之间的依赖、技能模板、Copilot/AGENTS 指令和本地联调同步;当需求涉及 hai-framework 源头修改、skills 同步、framework:use:local、framework:watch、版本漂移或双仓 PR 时使用。 |
hai-framework-sync — hai-framework 与应用仓库同步规范
能力契约
| 项目 | 契约 |
|---|
| 能力 | 管理 hai-framework 与应用仓库之间的依赖、技能模板、Copilot/AGENTS 指令和本地联调同步;当需求涉及 hai-framework 源头修改、skills 同步、framework:use:local、framework:watch、版本漂移或双仓 PR 时使用。 |
| 适用场景 | 当任务与 hai-framework-sync 的能力描述匹配,并且需要遵循本 Skill 的流程和边界时 |
| 输入 | 用户目标、仓库与运行环境上下文、现有配置、授权范围和质量门禁 |
| 输出 | 与目标匹配的配置/代码/文档或审查结论,以及可复现的验证结果 |
| 限制 | 不扩张用户授权,不输出或固化密钥,不跳过失败门禁,不假定外部服务状态 |
hai-framework 是能力与 skill 模板源头;应用仓库消费这些能力,并可以有少量项目本地覆盖。同步的目标是减少漂移,而不是把两个仓库混成一个仓库。
适用场景
- 修改
.agents/skills/**,且内容应成为所有 hai-framework 应用通用规范
- 修改
packages/cli/templates/skills/**
- 调整
AGENTS.md、CLAUDE.md、opencode.json、Copilot 指令模板
- 使用
framework:use:local / framework:watch 联调本地 hai-framework
- 排查应用仓库与 hai-framework npm 版本不一致
- 规划双仓 PR 或同步发布
同步原则
- 通用规范先改 hai-framework:可复用的 skill、模板、AI 工作流从
packages/cli/templates/skills/ 起源。
- 应用仓库只保留项目差异:业务上下文、项目私有路径、产品决策可以留在应用仓库。
- 默认 CI 使用 npm 依赖:确保 PR 能代表真实安装环境;本地路径联调必须显式开启。
- 双仓改动要成套:framework 模板、应用本地
.agents/skills、AGENTS/Copilot 路由同时更新。
- 不复制敏感聊天记录:只同步脱敏后的团队规则和流程。
标准同步流程
1. 判断来源
| 变更类型 | 首选位置 |
|---|
| 通用 hai 模块用法 | hai-framework/packages/cli/templates/skills/hai-*/SKILL.md |
| 通用 CI/PR/Issue/AI 协作流程 | hai-framework/packages/cli/templates/skills/ |
| 应用私有业务规则 | 应用仓库 AGENTS.md 或本地 skill |
| Copilot/Claude/OpenCode 入口模板 | hai-framework 模板 + 应用仓库入口文件 |
2. 修改源头
先在 hai-framework 模板中修改或新增 skill。
3. 同步到应用仓库
把源头 skill 复制到应用仓库 .agents/skills/<skill>/SKILL.md,并同步入口引用:
AGENTS.md
.github/copilot-instructions.md
CLAUDE.md(如存在)
opencode.json(如结构变化)
4. 验证
按变更类型选择验证方式:
- 仅模板 / skill 变更:检查 diff、入口引用与模板泛化程度。
- 同步到应用仓库:按
hai-ci 定义的质量门禁运行。
- 涉及 framework runtime 时,再选择:
pnpm framework:status
pnpm framework:use:local <package>
pnpm framework:watch <package>
漂移检查清单
禁止事项
- ❌ 只改应用
.agents/skills,忘记更新 hai-framework 模板中的通用规范
- ❌ 在 CI 默认路径中依赖本机绝对路径
- ❌ 把 unpublished framework 行为当成已发布 npm 行为
- ❌ 把聊天记录原文、token、私有 URL 写入模板
- ❌ 双仓 PR 没有关联 issue 或同步说明
相关 Skills
hai-ci — CI 对 npm/local framework 模式的验证策略
hai-pr-review — 双仓 PR 审查要点
hai-build — 应用开发入口