Imported from zhengaimin/aimin-skill (
skills/template/AGENTS.md). Install upstream withnpx skills add zhengaimin/aimin-skill --skill template. Copyright stays with the author.
Aimin-skill
本文件作为项目规则入口,只保留通用工作边界与规则路由;具体规范在命中场景后按需读取 .agent/** 文件。
工作方式
读取规则
- 先检查当前任务、目录结构和相关代码,再决定需要读取的规则文件。
- 默认不预读全部
.agent/**;命中具体场景后,再按路由表读取对应文件。 - 项目侧规则优先级高于通用模板;规则文件缺失时,优先遵守当前代码风格与本文件约束。
修改边界
- 只实现当前任务需要的最小改动,不添加未请求的功能、抽象、配置化或未来扩展点。
- 只修改与任务直接相关的文件;不顺手重构、格式化、改写注释、删除旧代码或清理无关问题。
- 只清理本次改动造成的未使用导入、变量和函数;发现无关问题时,在交付说明中单独指出。
编码标准
- 只使用过一次的内容,不需要封装;只有使用到 2 次时,才考虑是否封装,但不是一定封装。
- 代码应保持简洁直接,避免添加没有实际收益的冗余判断或防御式分支。
逻辑封装与抽象原则
- 反对碎片化:严禁为了拆分而拆分。除非某段逻辑具有极高的通用复用价值,或者单个方法代码行数确实过长(例如超过 80 行),否则保持业务逻辑连贯。
- 拒绝过度设计:禁止将一段完整的业务流程拆分成无数个仅调用一次的微型私有方法。
- 可读性优先:优先保证逻辑在当前方法内能够一眼看到底,减少在不同方法间频繁跳转导致的思维中断。
代码注释
- 新增或修改代码时,同步检查注释是否需要补充、调整或删除;具体范围、格式和边界以
.agent/comment.md为准。
文档与收尾
- 涉及第三方库、框架、SDK 或依赖 API,且存在版本差异或不确定时,先使用 Context7 MCP 查询最新文档。
- 只要本次会话修改了代码,收尾时必须按
.agent/scripts/lint.md对本次修改文件执行 lint;优先按文件路径或最小范围执行,不默认全量执行。
项目级别规则
- 由
/am:archive维护,使用表格记录“修改范围 / 对应归档文档 / 读取要求 / 备注”。 - 修改某个功能点、页面或模块前,先读取对应
.agent/archive/**文档,再结合当前用户 prompt 进行确认。 - 修改代码后,把关键变更、影响范围和待确认事项回写到对应归档文档。
- 不要覆盖
# Aimin-skill受管段落,也不要把项目独有规则写回模板基线。
| 修改范围 | 对应归档文档 | 读取要求 | 备注 |
|---|---|---|---|
| ... | ... | 修改前必读 | 先读文档和 prompt 再改代码 |
路由表
| 场景 | 读取文件 | 说明 |
|---|---|---|
| 接口新增、接口更新 | 当前接口目录、.agent/api.md、.agent/index/constants.json、.agent/index/utils.json |
接口落点、类型命名、枚举协同 |
| 系统常量、枚举维护 | .agent/index/constants.json |
常量索引、文件位置、枚举值摘要 |
| 公共方法、工具函数 | .agent/index/utils.json |
公共方法索引、用途、文件位置 |
| 注释规范 | 当前项目现有注释风格、.agent/comment.md |
注释语言、格式与使用边界 |
| 命名、代码顺序 | 当前项目现有实现、.agent/naming.md |
通用命名与代码组织规范 |
| lint、交付收尾 | .agent/scripts/lint.md |
收尾检查与交付前清单 |