SuperAPI AI 工具集

development-standards

编程与开发

查看项目

更新于 11-10 21:02

技能介绍

用途

该技能用于在开发任务中统一落实实现标准。适用对象是任何会改变代码、测试、依赖、构建配置、Shell 脚本或 CI 的任务;任务若只是文档编写或咨询建议,则不调用它。

主要能力

按技术栈路由参考文件:只读取与变更文件匹配的参考文档。

  • Python 源码、测试、pyproject.toml 或 Python 锁文件:references/python.md
  • JavaScript、TypeScript、package.json 或 Node 锁文件:references/node-typescript.md
  • Rust 源码、Cargo.toml 或 Cargo.lock:references/rust.md
  • Go 源码、go.mod 或 go.sum:references/go.md
  • Shell 脚本:references/shell.md
  • GitHub Actions 工作流或 action 元数据:references/github-actions.md

混合变更时加载每个匹配的参考文件,不额外加载其他参考。

代码规范要点:

  • 同一模式在多个位置出现后才创建共享工具;
  • 偏好显式控制流与内聚模块;对冗长、复杂、深层嵌套的函数以及参数过多的接口进行简化或说明理由;
  • 优先使用标准库或已有依赖;新增或升级依赖前核验受支持版本与兼容性、检查锁文件、遵循项目的固定版本与供应链策略;
  • 报错需包含操作、相关输入或状态以及有用的下一步,不吞掉错误;
  • 删除被注释掉的代码;注释应解释约束或意外行为。

测试规范要点:

  • 测行为而非实现细节;覆盖边界、畸形与空输入、失败以及有意设计的错误路径;
  • 只对慢速、非确定或外部边界做 mock;
  • 针对回归或重要不变式,确认测试在错误行为下会失败;
  • 修复由本次变更引起的告警;无法安全移除时使用范围最窄的有效抑制并说明原因。

使用方式

作为 Codex 配置/技能使用,在触发实现类任务时由模型按上述路由规则读取对应参考文件,并依规范执行变更;文档或咨询任务跳过。

适用场景与限制

适用于多语言项目的代码审查式实现、测试编写、依赖管理与 CI 变更。限制:它是规范性指引,不是自动化检查工具;各语言参考文件的具体内容暂未提供;技能自身不包含运行时功能或收费信息(暂未提供)。