From 84152917726de68768bf43e08c29861b6609c938 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B9=9B=E5=85=AE?= Date: Thu, 11 Jun 2026 17:48:08 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E8=A1=A5=E9=BD=90=E5=91=98=E5=B7=A5?= =?UTF-8?q?=E7=AB=AF=20agent=20skill=20=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - .agents: 新增中文提交与注释同步 skill 及项目索引 - AGENTS.md: 增加本地 skill 入口并保留 RTK 引用 - README.md: 同步 Agent 文档入口 --- .agents/README.md | 21 ++++++ .../skills/chinese-commit-message/SKILL.md | 54 +++++++++++++++ .agents/skills/header-comment-sync/SKILL.md | 68 +++++++++++++++++++ AGENTS.md | 13 ++++ README.md | 4 ++ 5 files changed, 160 insertions(+) create mode 100644 .agents/README.md create mode 100644 .agents/skills/chinese-commit-message/SKILL.md create mode 100644 .agents/skills/header-comment-sync/SKILL.md create mode 100644 AGENTS.md diff --git a/.agents/README.md b/.agents/README.md new file mode 100644 index 0000000..cae5977 --- /dev/null +++ b/.agents/README.md @@ -0,0 +1,21 @@ +# role-user Agent Skills + +本目录存放 `role-user` 的项目级 Agent skill。规则参考 SeaCloud 项目的 agent skill 组织方式,并按当前员工端 Next.js、TypeScript、移动端工作台场景保留最小必要规范。 + +## 使用入口 + +1. 进入仓库后先读 `AGENTS.md` 和 `RTK.md`。 +2. 创建或修改代码文件时,使用 `header-comment-sync` 保持中文文件头、导出声明和复杂逻辑注释同步。 +3. 提交或推送代码时,使用 `chinese-commit-message` 生成英文 type 前缀加中文摘要的 commit message。 +4. 所有 skill 的触达文件补齐规则只处理本次任务相关文件,不要求为了单次任务全仓扫描。 + +## 当前项目事实 + +- 应用类型:员工端 C 端移动优先工作台。 +- 技术栈:Next.js App Router、React、TypeScript。 +- 关键边界:BFF Route Handlers 负责会话与后端转发,前端不持久化 JWT 或明文密码。 + +## Skill 索引 + +- `header-comment-sync`:中文文件头、导出声明、复杂逻辑和风险边界注释。 +- `chinese-commit-message`:中文提交信息格式。 diff --git a/.agents/skills/chinese-commit-message/SKILL.md b/.agents/skills/chinese-commit-message/SKILL.md new file mode 100644 index 0000000..5bb2f56 --- /dev/null +++ b/.agents/skills/chinese-commit-message/SKILL.md @@ -0,0 +1,54 @@ +--- +name: chinese-commit-message +description: 在本仓库执行 git commit、整理提交说明或准备推送时使用,保持提交信息使用英文类型前缀加中文描述。 +--- + +# 中文提交信息 + +## 何时使用 + +- 用户要求提交、推送或整理 commit message。 +- 你准备执行 `git commit`。 +- 需要总结当前 diff 的提交说明。 + +## 核心要求 + +1. 提交信息必须使用英文 type 加中文摘要,例如 `feat: 补齐员工端 agent skill 规范`。 +2. 常用 type 优先使用 `feat`、`fix`、`refactor`、`docs`、`chore`。 +3. 不强制 scope;只有模块边界非常清楚时才使用 `feat(auth): ...`。 +4. 标题部分使用简洁中文,直接说明改动,不写“修改一下”“更新代码”这类空泛描述。 +5. 非 trivial 改动建议补中文正文,用扁平 bullet 按文件或内容块说明关键动作。 +6. 正文与标题之间空一行;正文每条 bullet 对应一个独立文件或明确内容块。 +7. 如果用户指定提交信息,优先尊重用户原意,只做必要格式整理。 + +## 触达文件补齐 + +- 不要求为了提交信息单独全仓扫描。 +- 提交前如果 diff 中的触达文件明显违反对应 skill 的触达补齐要求,应先修正当前相关链路,再整理 commit message。 +- commit 正文应概括本次触达补齐,例如“补齐触达文件注释”“同步 README 目录说明”。 + +## 推荐结构 + +```text +feat: 补齐员工端 agent skill 规范 + +- .agents/README.md: 新增项目级 skill 索引和使用入口 +- .agents/skills: 补充中文提交与注释同步规则 +- AGENTS.md: 增加本地 skill 入口 +``` + +## 不推荐写法 + +- `新增规则` +- `feat: add skills` +- `fix bug` +- `update` +- 复杂改动只有标题没有正文。 +- 正文写成长段流水账或嵌套列表。 + +## 落地检查 + +- type 是否合理。 +- 中文摘要是否覆盖主改动。 +- 是否需要正文。 +- 正文是否按文件或内容块归纳。 diff --git a/.agents/skills/header-comment-sync/SKILL.md b/.agents/skills/header-comment-sync/SKILL.md new file mode 100644 index 0000000..86cd1e0 --- /dev/null +++ b/.agents/skills/header-comment-sync/SKILL.md @@ -0,0 +1,68 @@ +--- +name: header-comment-sync +description: 在本仓库创建或修改 ts、tsx、js、jsx、mjs、cjs、vue、astro 文件时使用,保持中文文件头、导出声明、复杂逻辑和风险边界注释准确。 +--- + +# 注释规范与同步 + +## 目标 + +让下一次进入文件的维护者能快速理解当前职责、关键约束和风险边界。注释解释“为什么”和“边界”,不复述代码表面行为。 + +## 适用场景 + +- 新增或修改页面、组件、Hook、store、service、utils、类型、配置或脚本文件。 +- 修改 BFF Route Handler、鉴权、Cookie、权限、后端协议转换、缓存或错误兜底逻辑。 +- 发现旧注释与当前代码行为不一致。 + +## 核心原则 + +- 注释使用中文,描述当前事实。 +- 简单局部变量不强行注释。 +- 文件头说明文件当前职责,1 到 2 行即可。 +- 导出的函数、组件、Hook、类型、配置对象、service method 应有用途说明。 +- 复杂兼容逻辑、后端协议、竞态锁、缓存、权限映射和会话安全边界需要短注释。 +- TODO/FIXME 必须说明触发条件、剩余动作和可删除条件。 + +## 文件头规则 + +- 每个适用文件都要有准确文件头。 +- 如果文件必须以 `"use client"` 或 `"use server"` 开头,文件头注释放在指令之后、导入之前。 +- Vue 文件不为了补头注释重排模板结构;在 `