SuperAPI AI 工具集

coding-principles

编程与开发

查看项目

更新于 10-16 01:15

技能介绍

用途:coding-principles 是编码类任务的统一实现纪律来源,作为活动上下文加载,使代理在每次会话中自动套用相同规则,而无需用户重复交代。它只塑造后续的 Edit/Write 调用方式,本身只读:不修改文件、不输出报告、不运行 linter、格式化器或重构工具。

适用时机:当代理要编写、实现、修复、重构或清理代码(对源码的任何 Edit/Write/NotebookEdit)、评审 diff/PR 质量,或撰写涉及注释、docstring、注解的规划文档(计划、ADR、工作说明)时触发。探索类任务(如“X 如何工作”)、纯文档/配置/数据改动、运维操作(部署、重启、回滚)和安全评审不触发。任务一旦触发,其注释能力规则覆盖该任务触及的所有文件。将编码委派给子代理时,需在 spawn 提示中要求其先加载 capabilities/comments/capability.md,或按该能力评审其 diff。

主要能力:内置 16 条通用准则(mantra),分三层。第一层目标:可读性优先、KISS、可测试性、可扩展性、可观测性;第二层设计:单一职责、组合式模块化、强类型、快速且响亮地失败、默认不可变、使非法状态不可表示、行为局部性、纯函数与副作用分离、显式优于隐式;第三层修剪:DRY、YAGNI。另有 21 条编号原则,每条带 must/should/could 严重度,用于分诊:先修 must,再建议 should,could 静默应用。冲突时准则层级优先,同层逐例判断。文件布局上,SKILL.md 为常驻路由器,按需加载 references/mantras.md、principles.md、glossary.md、smells.md,以及按关注点加载 api-design、persistence、observability、platform-matrix、resilience、data-handling、architecture、configuration、testing、refactoring 等参考文件,并按语言加载 capabilities/<lang>/capability.md。每条规则只在一个文件中规范陈述,其余位置只作指针。

使用方式:代理在改动前后按内置检查清单自检(清单不输出),包括理解为什么、最小范围、缺陷修复先有失败测试、阅读目标文件与调用方、遵循仓库既有约定、避免过早抽象与逃逸类型、不吞异常、不记录密钥、报告前验证改动确实生效等。

限制:资料未提供收费、价格、平台支持范围与具体安装命令等信息。该技能不执行任何工具,不产出文件改动或报告;货币性说明有限,命名工具或运行时版本的建议带有最后核对月份标记,超出该日期需重新核实。