用途:为 AI 编码代理提供一套务实的编码标准,目标是让输出简洁、直接、面向解决方案,避免过度设计与冗余解释。
主要能力与规则:核心原则包括单一职责(每个函数/类只做一件事)、DRY(抽取重复、复用)、KISS(用能跑通的最简方案)、YAGNI(不构建用不到的功能)与“童子军规则”(让代码比接手时更干净)。命名上要求变量体现意图(如 userCount 而非 n)、函数用动词加名词(如 getUserById())、布尔值用疑问形式(isActive、hasPermission、canEdit)、常量用 SCREAMING_SNAKE 风格;若需靠注释解释命名,就应重命名。函数要求短小(最多 20 行,理想 5-10 行)、只做一件事、单一抽象层级、最多 3 个参数、避免意外修改入参。结构上提倡卫语句提前返回、控制嵌套层级不超过 2 层、用小函数组合并就近放置相关代码。反模式清单包括逐行注释、为单行代码造 helper、为 2 个对象建工厂、在 utils.ts 里只放一个函数、写“首先我们 import……”这类叙述、深层嵌套、魔法数字、上帝函数。
使用方式:强调 AI 编码风格——用户要功能就直接写、报 bug 就直接修而不先解释、需求不清就先问不要假设。编辑任何文件前先思考:谁 import 这个文件、它 import 了什么、哪些测试覆盖它、是否为共享组件,并规定在同一任务中同时修改该文件及其所有依赖文件,绝不留下损坏的导入或缺失更新。完成任务前需自检目标是否达成、必要文件是否都改、代码是否验证通过、lint 与 TypeScript 是否通过、有无遗漏边界情况。资料还规定每个 agent 只运行自己技能的验证脚本(如前端跑 ux_audit.py,后端跑 api_validator.py,安全跑 security_scan.py,测试跑 test_runner.py,任意 agent 可跑 lint_runner.py 等),脚本输出必须遵循“读取→汇总→询问”流程,先汇总错误、警告与通过项并询问是否修复,等待用户确认后再修,修完重跑确认;忽略输出或未经询问自动修复均视为违规。
适用场景与限制:适用于 AI 辅助编码代理规范化代码产出与验证流程。资料未说明具体支持的语言、平台、安装方式、收费情况或效果数据,也未提供官方仓库信息,这些暂未提供。