SuperAPI AI 工具集

ecc-conventions

编程与开发

查看项目

更新于 11-10 16:20

技能介绍

ECC Conventions 是一个开发约定与模式技能,用于让 Claude 在 ECC 项目中按照既有规范进行开发。该技能由 ECC Tools 自动生成,生成来源为 affaan-m/ECC,生成日期为 2026-03-20。

用途

当需要对该仓库进行修改、按既有模式添加新功能、编写符合项目约定的测试,或创建格式正确的提交信息时,可激活此技能。

技术栈与架构

项目主语言为 JavaScript,采用混合模块组织方式,测试文件独立存放。项目结构为单包(Single Package)。配置文件中列出了多个 GitHub Actions 工作流(ci.yml、maintenance.yml、monthly-metrics.yml、release.yml、reusable-release.yml、reusable-test.yml、reusable-validate.yml),以及 .opencode/package.json、.opencode/tsconfig.json、.prettierrc、eslint.config.js、package.json。

提交约定

提交风格为 Conventional Commits,基于 500 次提交分析。常用前缀包括 fix、test、feat、docs。消息平均长度约 65 字符,首行应简洁且具描述性,使用祈使语气(如 "Add feature" 而非 "Added feature")。资料中给出的提交示例包括:feat(rules): add C# language support;chore(deps-dev): bump flatted (#675);fix: auto-detect ECC root from plugin cache when CLAUDE_PLUGIN_ROOT is unset (#547) (#691);docs: add Antigravity setup and usage guide (#552);merge: PR #529 — feat(skills): add documentation-lookup, bun-runtime, nextjs-turbopack; feat(agents): add rust-reviewer;Revert "Add Kiro IDE support (.kiro/) (#548)";Add Kiro IDE support (.kiro/) (#548);feat: add block-no-verify hook for Claude Code and Cursor (#649)。

代码风格

命名约定:文件使用 camelCase,函数使用 camelCase,类使用 PascalCase,常量使用 SCREAMING_SNAKE_CASE。导入风格为相对导入,导出风格为混合风格。资料给出的导入示例为:import { Button } from '../components/Button' 与 import { useAuth } from './hooks/useAuth'。

测试

未检测到特定测试框架,建议使用仓库现有测试模式。文件模式为 *.test.js。测试类型包括单元测试(隔离测试单个函数与组件)和集成测试(测试多个组件或服务之间的交互)。项目已配置覆盖率报告,目标为 80% 以上。

错误处理

错误处理风格为 try-catch 块。资料给出的标准模式为:try { const result = await riskyOperation(); return result } catch (error) { console.error('Operation failed:', error); throw new Error('User-friendly message') }。

常见工作流

资料从提交模式中归纳出以下工作流:

数据库迁移:约每月 2 次,步骤为创建迁移文件、更新 schema 定义、生成或更新类型;涉及文件如 **/schema.、migrations/。

功能开发:约每月 22 次,步骤为添加功能实现、添加测试、更新文档;涉及文件如 manifests/、schemas/、/.test.、/api/**。

添加语言规则:约每月 2 次,在 rules/{language}/ 下创建新目录,添加 coding-style.md、hooks.md、patterns.md、security.md、testing.md 等语言特定内容文件,可选引用相关技能。

添加新技能:约每月 4 次,在 skills/{skill-name}/ 下创建新目录,添加 SKILL.md 文档(When to Use、How It Works、Examples 等),可选在 scripts/ 下添加脚本或支持文件,并根据评审反馈迭代文档。

添加新智能体:约每月 2 次,在 agents/{agent-name}.md 创建智能体 markdown 文件,在 AGENTS.md 中注册,可选更新 README.md 与 docs/COMMAND-AGENT-MAP.md。

添加新工作流入口:约每月 1 次,优先使用 skills-first,仅在需要旧式斜杠兼容时添加命令 shim;在 skills/{skill-name}/SKILL.md 创建或更新规范工作流,必要时添加或更新 commands/{command-name}.md。

同步目录计数:约每月 3 次,将 AGENTS.md 与 README.md 中记录的智能体、技能、命令数量与实际仓库状态同步,可选更新其他文档文件。

添加跨 harness 技能副本:约每月 2 次,将 SKILL.md 复制或适配到 .agents/skills/{skill}/SKILL.md 和/或 .cursor/skills/{skill}/SKILL.md,可选添加 harness 特定的 openai.yaml 或配置文件,并根据评审反馈对齐 CONTRIBUTING 模板。

添加或更新 hook:约每月 1 次,在 hooks/ 或 scripts/hooks/ 添加或更新 hook 脚本,在 hooks/hooks.json 或类似配置中注册,可选在 tests/hooks/ 添加或更新测试。

处理评审反馈:约每月 4 次,编辑 SKILL.md、智能体或命令文件以回应评审意见,按要求更新示例、标题或配置,迭代直至所有反馈解决。

最佳实践

建议使用 conventional commit 格式(feat:、fix: 等),遵循 *.test.js 命名模式,文件名使用 camelCase,优先使用混合导出。不建议编写含糊的提交信息,不为新功能跳过测试,不在未讨论的情况下偏离既有模式。

限制

资料未提供该技能的收费、价格、平台支持范围、具体安装命令或使用效果等信息,这些内容暂未提供。该技能为自动生成,建议根据团队需要进行审查与定制。