SuperAPI AI 工具集

code-standards

编程与开发

查看项目

更新于 10-16 02:18

技能介绍

用途

code-standards 是一个面向代码变更的执行工作流技能,适用于实现功能、修复缺陷或重构代码的场景。它的核心主张是:在写代码之前先确定执行顺序,而不是边写边想。该技能与具体技术栈无关,所有命令都需要根据项目实际工具链进行调整。

主要能力

技能定义了一套按顺序执行的步骤:

  1. 定位(Orient):阅读项目的经验/坑点文件(例如 tasks/lessons.md)并遵守;只查找并阅读与所改子系统相关的那一份文档,而不是整棵目录树。
  2. 计划(Plan):对于非平凡改动(3 步以上或涉及架构选择),在 tasks/todo.md 中写简短计划,包含涉及文件、要新增的测试、风险。如果方向跑偏,应停下重新计划。
  3. 基线(Baseline):在动手之前先让项目的构建与测试命令通过。如果基线本来就是红的,应把它作为第一项任务处理,绝不在破损基线上继续构建。
  4. 实现(Implement):做最小的根因改动,手工匹配周围代码风格。不要对触碰的文件运行大规模自动格式化工具,以免真实 diff 被噪声淹没。
  5. 测试(Test):新行为要有在缺少该改动时会失败的测试;安全门要有反向断言测试(错误令牌 → 拒绝、状态不变、无数据泄露)。
  6. 验证(Verify):在宣布完成前,运行完整检查套件(构建 + lint + 类型检查 + 测试)直至通过。
  7. 自审(Self-review):像审查别人的 PR 一样审查自己的 diff(或调用审查技能),在呈现前修复发现的问题。
  8. 收尾(Close out):在同一次变更中更新文档;如果被纠正或遇到意外,追加到经验文件;编写符合约定式提交规范的消息(feat|fix|docs(scope): …)。

使用方式

技能本身不提供可执行命令,而是规定执行顺序。使用前需要先阅读项目自身的文档(README、CONTRIBUTING、AGENTS.md/CLAUDE.md、Makefile 或 package scripts),了解其构建、测试、lint 和格式化命令,然后按上述步骤推进。

触发警示(Tripwires)

当即将进行以下操作时,应停下并重新核对项目指南:

  • 改动公共或共享接口(API、线格式、schema)→ 检查所有调用方,优先采用增量式改动。
  • 新增依赖 → 权衡传递依赖的重量与许可证,并判断标准库是否已覆盖该需求。
  • 触碰鉴权、令牌或权限 → 审计所有写入方与读取路径,补充反向测试。
  • 将密钥写入磁盘 → 使用平台提供的原子创建私有文件 API,绝不先写再 chmod。
  • 在 await 或阻塞调用期间持锁,或在逻辑内部读取环境变量 → 提取纯决策函数。

无进展保护

同一失败在两次修复尝试后仍然存在,意味着应当停止:把发现写入经验文件,将该项标记为 [BLOCKED],并向上暴露。不要反复无效尝试。

适用场景与限制

该技能适用于任何需要纪律化推进的代码改动,尤其是涉及公共接口、依赖、鉴权、密钥和并发等高风险区域。其限制在于:技能本身不绑定具体语言或框架,所有命令与工具链细节均需依据项目实际情况确定;技能未提供具体的命令示例、安装方式或平台支持信息,这些内容暂未提供。