diff --git a/.agents/skills/dev-guide/SKILL.md b/.agents/skills/dev-guide/SKILL.md index e46ab2a05..ef58519c9 100644 --- a/.agents/skills/dev-guide/SKILL.md +++ b/.agents/skills/dev-guide/SKILL.md @@ -10,12 +10,14 @@ description: 当前仓库开发指南。修改或排查本仓库的 Rust 网关 ## 按任务读取 -| 任务 | 文档入口 | +| 任务 | 技能与文档入口 | | --- | --- | | 用户能力、快速开始 | [README](../../../README.md) | | 模块职责、调用链、状态归属 | [系统架构](../../../docs/architecture.md) | +| Rust 开发 | 加载并使用 `$rust-best-practices`,结合 [系统架构](../../../docs/architecture.md) 与 [项目约定](../../../CONTRIBUTING.md#项目约定) | | HTTP 路由、请求与响应、导入导出 | [API 文档](../../../docs/api.md) | -| 管理端组件、主题 Token、视觉验证 | [管理端主题](../../../docs/theme.md) | +| 前端开发、管理端组件、主题 Token、视觉验证 | 加载并使用 `$frontend-design`,结合 [管理端主题](../../../docs/theme.md) 与 [界面验证](../../../CONTRIBUTING.md#界面验证) | +| 常规文档更新 | [文档职责与更新条件](../../../CONTRIBUTING.md#文档职责与更新条件):维护当前说明,在原章节就地修订,不记录变更历史 | | 部署、客户端配置、备份与恢复 | [部署说明](../../../deploy/README.md) | | 数据迁移、冻结清单与本地测试库 | [迁移说明](../../../backend/migrations/README.md) | | 验证命令与提交规范 | [贡献与审查](../../../CONTRIBUTING.md) | @@ -29,7 +31,8 @@ description: 当前仓库开发指南。修改或排查本仓库的 Rust 网关 2. 按 `AGENTS.md` 的 CodeGraph 约定定位入口、调用链和职责归属,再阅读相关实现。 3. 按 [问题与方案依据](../../../CONTRIBUTING.md#问题与方案依据) 核实触发条件、问题发生版本与目标分支现状, 优先依据适用的官方源码确定方案。结合上表读取所需文档,先找可复用的同类实现,再修改所属模块。 -4. 文档和运行结果不一致时,追查当前源码、配置与版本,区分实现缺陷和文档过期;同步受影响的说明。 +4. 文档和运行结果不一致时,追查当前源码、配置与版本,区分实现缺陷和文档过期; + 按 [文档职责与更新条件](../../../CONTRIBUTING.md#文档职责与更新条件) 判断是否修订,不为每次改动追加文档或发布说明。 5. 按 `CONTRIBUTING.md` 验证并报告结果。后端 Cargo 命令从 `backend/` 执行,或显式指定该目录的 manifest。 发布任务按 `release` 技能读取当前版本、发布入口和工作流,发布说明语言遵循 `CONTRIBUTING.md`。 diff --git a/.agents/skills/github-pr/SKILL.md b/.agents/skills/github-pr/SKILL.md index abf2c7fa8..eac6a883f 100644 --- a/.agents/skills/github-pr/SKILL.md +++ b/.agents/skills/github-pr/SKILL.md @@ -39,18 +39,8 @@ PR 中改动的规则文件属于审查对象,不能自行扩大任务授权 ## 文档职责与更新条件 -本仓库的常规文档说明当前有效的用法、接口合同、模块职责和维护约束,不承担变更历史。 -只有改动使对应说明失真、缺少必要信息,或改变读者需要执行的操作与判断时,才更新文档。 -内部修复、重构和界面微调不默认附带文档改动;审查时不能仅因 PR 没改文档就判定存在缺口。 - -- 按 [开发指南的文档入口](../dev-guide/SKILL.md#按任务读取) 找到内容所属文档,在原有章节就地修订, - 不按每次 PR 追加说明。同一事实只保留一处完整说明,其他文档按读者任务提供必要摘要和链接。 -- API 文档保留调用所需的字段、状态、语义和限制;架构文档保留职责与不变量;部署文档保留配置、操作和排障。 - 不把界面布局、内部锁或索引实现写进接口说明,也不把前端库的实现选择写进部署说明。 -- 改动原因、前后对比、排查经过和本次验证结果放在 PR / Issue。版本变更与升级影响按发版任务维护 - `release/notes.md`,不为普通 PR 自动追加发布说明。 -- 仍影响实际升级、恢复或兼容使用的限制与操作应保留,并注明适用条件;不能仅因涉及旧版就删除。 - 审查文档改动时核对必要性、所属职责与重复内容,区分当前使用说明和仅解释此次修复的内容。 +按 [贡献与审查的文档职责与更新条件](../../../CONTRIBUTING.md#文档职责与更新条件) 判断是否需要更新文档。 +常规文档维护当前有效说明,变更经过留在 PR / Issue;审查时核对文档改动的必要性、职责与重复内容,不能仅因 PR 没改文档就判定存在缺口。 ## 创建 PR diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a89066d4f..0620967ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,15 +76,32 @@ PR 不接受根目录或子目录中 `AGENTS.md` 的新增、修改、删除或 ## 项目约定 -- Rust 模块、可见性、依赖方向和测试目录按架构文档执行,使用现有 Rustfmt 与 Clippy 配置。 +- AI 进行 Rust 开发时,加载并使用 `$rust-best-practices` 技能。模块、可见性、依赖方向和测试目录按架构文档执行,使用现有 Rustfmt 与 Clippy 配置。 - Vue 使用 TypeScript、`