📚 工程方法 全难度 📦 community

coding-standards

通用编码规范、命名、注释、提交规范。

8.8 /10 ★★★★☆
#免费#设计模式#编程
📄 相关文章

📊 评分明细

📦 打包完整度
2.2 2.2 / 2.5
🎯 实用性
2.2 2.2 / 2.5
📖 文档清晰度
1.8 1.8 / 2
👥 社区影响力
1.3 1.3 / 1.5
🔗 集成度
1.3 1.3 / 1.5

🎯 适用场景

免费设计模式编程

coding-standards 快速入门

团队代码风格的”宪法”,让 10 个人的代码看起来像 1 个人写的。

这是什么?解决什么问题?

没有规范的项目是什么样?——同一个项目里同时出现 userId / user_id / uid 三种命名;函数有的 30 行有的 300 行;有的文件末尾有换行有的没有;提交信息五花八门(fix bug、Update index.js、refactor、#12345)…… coding-standards 是来自 affaan-m/everything-claude-code 仓库的工程方法 Skill,核心内容是”跨语言、跨团队”的通用编码约定。它包含命名约定(变量/函数/类/常量分别用什么 case)、注释规范(什么该写什么不该写)、提交信息(Conventional Commits 1.0.0 规范)、Lint 配置建议(ESLint/Prettier/Ruff/Black 的推荐组合)、代码组织(目录结构、模块边界)。 加载这个 Skill 后,AI 在写代码时会主动遵守团队的命名风格、提交信息规范,生成的代码不需要”返工改格式”。特别适合刚启动的项目(提前定规范避免后期吵架)、接手 legacy 项目的团队(快速建立统一风格)、多人协作的开源项目(降低 PR review 的风格摩擦)。

准备工作

  1. Claude Code / Cursor / 任意 AI 编程客户端
  2. Git 仓库:建议有 main 分支 + 保护规则
  3. Lint 工具:ESLint/Prettier/Pylint/Ruff 等,至少配一个
  4. 可选:husky + lint-staged,在 commit 前自动跑 lint

3 步快速上手

第 1 步:安装 Skill

npx skills add affaan-m/everything-claude-code --skill coding-standards

仓库:https://github.com/affaan-m/everything-claude-code

第 2 步:验证 Skill

向 AI 询问:

用 coding-standards Skill,生成一个符合 Conventional Commits 规范的提交信息模板,
我刚修复了登录页面的 token 刷新 bug

如果 AI 回答类似 fix(auth): refresh expired token on login page redirect,说明 Skill 加载成功。

第 3 步:把规范落到项目里

请用 coding-standards Skill 帮我写一个 CONTRIBUTING.md,涵盖命名、注释、提交规范

AI 会生成一份完整的团队规范文档,提交到 CONTRIBUTING.md,团队成员入职时阅读。

常见踩坑

  1. 规范太严反伤生产力:要求每行必须有注释、每个函数必须有 JSDoc,会拖慢开发。建议”复杂函数才写注释,自解释的代码不要写废话”。
  2. 命名风格分语言不一致:Python 用 snake_case,Java 用 camelCase,Go 用 mixedCaps,要分语言给规范,不要一刀切。
  3. 提交信息长度失控:Conventional Commits 的 scope 列表会膨胀,务必提供 allowedScopes 配置或写一个 commitlint 校验。
  4. Lint 配置互相覆盖:装了 ESLint 又装 Prettier,规则打架。eslint-config-prettier 必须装,用来关掉 ESLint 里和 Prettier 冲突的规则。
  5. 强制格式化引发大 diff:第一次启用 Prettier 改了 500 个文件的引号风格,review 工具一片红。要分阶段启用或 git blame 禁用。
  6. 规范文件没维护:CONTRIBUTING.md 写完吃灰,半年后项目语言都换了,规范没跟上。要随项目演进每季度 review 一次。

初级用法

  1. 命名约定:变量 camelCase、类 PascalCase、常量 UPPER_SNAKE、文件名 kebab-case(前端)或 snake_case(Python),AI 写代码时会自动遵守。
  2. 提交规范:用 feat: / fix: / refactor: / docs: / test: / chore: 前缀,可选 scope 标识模块,body 写动机,footer 写 BREAKING CHANGE。
  3. Lint 一键配置:让 AI 直接生成 .eslintrc.json / .prettierrc / pyproject.toml 的标准配置,避免自己纠结选项。

高级玩法

  1. 多语言 monorepo 规范:在 monorepo 根目录放一份共享的命名规范,各子项目用各自的 Lint,但保持命名风格一致。
  2. 自动化的规范守护:在 CI 里跑 commitlint,不合规的 commit 直接拒绝合并。
  3. PR 模板:用 .github/PULL_REQUEST_TEMPLATE.md 强制 PR 作者写”测试覆盖”、“截图”、“风险评估”等,让 review 更高效。

小技巧

  • 在 package.json 加 "type": "module",ESM 风格统一,避免 CJS/ESM 混用。
  • 用 editorconfig 统一编辑器配置(缩进、换行符、文件末尾换行),跨编辑器协作不再乱。
  • 提交时用 cz (commitizen) 交互式生成规范 commit,比手写不易出错。
  • 不要追求 100% Lint 零警告,适度放宽某些规则(如 no-unused-vars 对解构场景放过)。
  • 让 AI 帮忙做”code review”,用 Skill 扫一遍 diff,会比人眼 review 风格问题更彻底。

coding-standards Skill 多维度简评

类别:工程方法 来源:affaan-m/ECC(原名 everything-claude-code) 定位:跨项目编码规范——命名约定、代码格式、错误处理、日志、安全的硬性标准。

免责声明:本文基于官方文档和公开资料整理，未经过 MagicNetWorld 实测。

一、核心定位与价值

coding-standards 是 ECC(Everything Claude Code，后更名为 ECC——“The harness-native operator system for agentic work”)中的编码规范 Skill。ECC 由 Anthropic 黑客马拉松获奖者 Affaan Mustafa 创建，目前拥有 211K+ Stars 和 32K+ Forks，是最受欢迎的 AI Agent 配置框架之一。

核心价值:为 AI 编程 Agent 提供跨项目统一的编码规范，覆盖命名约定、代码格式(ESLint/Prettier)、错误处理模式、日志规范和安全性标准，确保 Agent 生成的代码符合团队编码标准。

ECC 包含 119 个 Skills、28 个专用 Subagent、60 个 Slash Commands 和内置的 AgentShield 安全扫描器(1,282 个测试用例 + 102 条静态分析规则)。coding-standards 是其中最基础的编码规范 Skill，为所有其他开发 Skill 提供代码风格基准。

二、核心能力清单

能力实现方式适用场景
代码格式规范ESLint/Prettier 规则集成新项目搭建、代码提交前检查
命名约定变量/函数/类/文件的统一命名模式团队协作、代码审查
错误处理规范try-catch 模式、错误传播策略后端服务、API 开发
日志规范日志级别、结构化日志格式生产环境可观测性
安全编码规范输入验证、SQL 注入防护、XSS 防御Web 应用、API 开发

三、编码规范的核心维度

3.1 命名约定

ECC coding-standards 推荐以下命名模式:

  • 变量/函数:camelCase(JavaScript/TypeScript)、snake_case(Python)
  • 类/接口/类型:PascalCase
  • 常量:UPPER_SNAKE_CASE
  • 文件名:kebab-case(前端)、snake_case(Python)
  • 布尔变量:以 is/has/should 开头

3.2 错误处理

  • 不要使用空的 catch 块(catch {} 或 except: pass)
  • 错误信息应包含足够的上下文(操作内容、失败原因、相关标识符)
  • 区分可恢复错误(用户输入无效)和不可恢复错误(数据库连接失败)
  • 使用自定义错误类而非裸字符串

3.3 日志规范

  • ERROR:需要人工介入的问题(数据库连接失败、API 返回 5xx)
  • WARN:需要注意但不阻塞的异常(重试成功、降级处理)
  • INFO:关键业务节点(用户注册、订单创建、支付完成)
  • DEBUG:开发调试信息(变量值、中间状态)

3.4 安全编码

  • 所有外部输入必须验证和净化
  • 数据库查询使用参数化查询(防止 SQL 注入)
  • 用户生成内容输出时进行 HTML 转义(防止 XSS)
  • 不在代码中硬编码密钥、密码或 Token

四、ECC 框架的完整生态

ECC 不仅是一个 Skill 集合，更是一个完整的 Agent 配置框架:

28 个专用 Subagent

  • Planning Agent:复杂功能拆解
  • TDD Agent:驱动测试驱动开发
  • Security Review Agent:漏洞扫描
  • 语言专用 Code Review Agent:TypeScript/Python/Go/Rust/Java/C++ 各一个

AgentShield 安全扫描器

内置的安全层拥有 1,282 个测试用例和 102 条静态分析规则，可在 pre-tool-use 事件中拦截危险操作(如 git push --force)，检测 prompt 中的密钥泄露，防止配置篡改。

跨平台支持

ECC 支持 Claude Code、Cursor、Codex、OpenCode、Gemini CLI、Zed、GitHub Copilot 等主流 AI Agent 平台。

五、与其他 Skill 的协同

coding-standards 在 ECC 框架中属于基础层 Skill，为以下 Skill 提供风格基准:

  • tdd-workflow:TDD 开发中生成符合规范的测试代码
  • continuous-learning:学习过程中沉淀符合规范的知识库条目
  • verification-loop:验证环节检查代码是否符合规范

六、安装与使用

# 通过 skills CLI 安装
npx skills add https://github.com/affaan-m/ECC --skill coding-standards

# 或克隆仓库
git clone https://github.com/affaan-m/ECC

在 CLAUDE.md 中启用:

skills:
  - coding-standards
auto_invoke:
  - when: "新项目搭建、代码审查、PR 检查"
    skill: coding-standards

七、总结

核心价值:

  • 覆盖命名、格式、错误处理、日志、安全五大编码规范维度
  • 依托 ECC 框架的 119 个 Skill 生态和 AgentShield 安全扫描
  • 跨平台兼容 Claude Code、Cursor、Codex、OpenCode 等主流 Agent

适用人群:

  • 所有需要在团队中推行统一编码规范的开发者

推荐程度:⭐⭐⭐⭐ —— 推荐安装。作为 ECC 框架的基础 Skill，与其他 ECC Skill 配合使用效果最佳。

参考资料

📊 评分与标签

评分说明

总分 8.8/10 · P_优选

测评日期：2026-07-07 | 质量等级：资料核验（基于公开文档/基准/评测数据整理）

📊 可观测社区指标（数据核验日期：2026-07-07 21:18 UTC+8）

  • GitHub: affaan-m/everything-claude-code ★227k, 🔱34.7k, 2,254 Commits, 33 Branches, 15 Tags
  • Issues/PRs: 20 Open Issues, 53 Open PRs, 启用 Discussions
  • 最近提交: 3 天前（commit 4130457 by affaan-m “fix(tests): use mkdtempSync for test scratch dirs”）
  • 仓库全称：“The agent harness performance optimization system. Skills, instincts, memory, security, and research-first development for Claude Code, Codex, Opencode, Cursor and beyond”
  • Sponsor 按钮启用（affaan-m/ECC 获得 GitHub Sponsors 赞助），是 Skill 品类中商业化最成熟的代表
  • 来源：GitHub 仓库主页 + Commits

📦 可安装性 2.3/2.5

  • 官方安装：npx skills add affaan-m/everything-claude-code --skill coding-standards，一行命令加载到 AI Agent
  • 33 Branches 表明多平台并行开发：.claude/（Claude Code）、.codex-plugin/ + .codex/（Codex）、.cursor/（Cursor）、.codebuddy/（CodeBuddy 腾讯），且 CodeBuddy 适配 4 个月前专门提交
  • 配套 plugin 完整：.claude-plugin/ + .codex-plugin/ + .codebuddy/ 等多平台原生支持，3 天前刚添加 .claude-plugin 更新（“feat(workflows): re-land orch-review workflow + add /orch-review command”）
  • 启动配置齐全：内含 .editorconfig、ESLint/Prettier/Ruff/Black 推荐组合、commitlint 配置示例，新项目 5 分钟可落地完整规范
  • 对比 JimLiu/baoyu-skills：baoyu-skills 走 npm 包分发；affaan-m/ECC 走 Skill + plugin 分发，工程规范场景下 ECC 更通用
  • 对比 addyosmani/agent-skills：addyosmani 偏 refactor/测试方法论，affaan-m 偏编码规范/提交规范/工作流编排；affaan-m 平台适配数量更多（10+ 种 IDE）
  • 数据来源：affaan-m/everything-claude-code + JimLiu/baoyu-skills

🎯 实用性 2.2/2.5

  • 核心内容：“跨语言、跨团队”的通用编码约定，涵盖命名约定（camelCase/PascalCase/UPPER_SNAKE/kebab-case/snake_case 分语言选择）、注释规范、Conventional Commits 1.0.0、Lint 工具组合、目录结构与模块边界
  • AI 加载 Skill 后会主动遵守团队命名风格、提交信息规范（feat:/fix:/refactor:/docs:/test:/chore:），生成的代码不需要”返工改格式”
  • 典型应用场景：① 刚启动项目（提前定规范避免后期吵架）；② 接手 legacy 项目（快速建立统一风格）；③ 多人协作开源项目（降低 PR review 风格摩擦）
  • 实战经验沉淀：6 类常见踩坑（规范太严反伤生产力、命名风格分语言不一致、提交信息长度失控、Lint 配置互相覆盖、强制格式化引发大 diff、规范文件没维护）
  • 对比 code-simplification (addyosmani/agent-skills)：code-simplification 偏架构/复杂度治理（Chesterton 围栏、500 行规则）；coding-standards 偏命名/格式/提交规范（Conventional Commits、ESLint），分工明确
  • 对比直接用 Conventional Commits 规范：官方规范文档无 AI 集成示例，本 Skill 把规范封装为 AI 可直接调用的工作流
  • 数据来源：coding-standards README + Conventional Commits 规范

📖 文档质量 1.6/2.0

  • README 涵盖：命名约定分语言选择、提交规范（feat:/fix:/refactor:/docs:/test:/chore: + 可选 scope）、Lint 一键配置、6 类常见踩坑清单；高级用法含 monorepo 共享规范、commitlint 自动化守护、PR 模板
  • docs/ 目录（3 天前更新 “docs: MRR-biased ECC Pro + AgentShield security roadmap”）含完整文档和商业化路线图
  • 主要短板：仅英文文档、无多语言支持；Coding Standards 内容主要在 README 中，缺少独立 docs/ 文件
  • 对比 JimLiu/baoyu-skills：baoyu-skills 有中英双语 README.zh.md；affaan-m 仅英文，国际化覆盖较弱
  • 对比 addyosmani/agent-skills：addyosmani 提供 README + docs/ + AGENTS.md 多层文档；affaan-m 文档集中度高但层次略少
  • 数据来源：coding-standards README + Conventional Commits 规范 + ESLint 文档

👥 社区活跃 1.4/1.5

🔗 兼容性 1.3/1.5

  • 多平台原生支持（33 Branches + .claude-plugin + .codex-plugin + .cursor + .codebuddy + .opencode + .gemini 等），覆盖 Claude Code / Codex / Cursor / CodeBuddy / OpenCode / Gemini CLI 等主流 AI 客户端
  • 4 个月前专门添加 “feat(install): add CodeBuddy(Tencent) adaptation with installation script”，覆盖腾讯 CodeBuddy IDE
  • 主语言无关：支持 Python (Ruff/Black)、JavaScript/TypeScript (ESLint/Prettier)、Java/Go/C++/Rust 等主流编程语言；命名风格按语言差异化（Python snake_case、Java camelCase、Go mixedCaps）
  • 提供完整 CI/CD 集成：commitlint 校验 + ESLint 配置 + husky + lint-staged 钩子，团队级规范守护
  • 对比 addyosmani/agent-skills：addyosmani 平台适配略少（Claude Code / Gemini / OpenCode / Antigravity），affaan-m 平台适配更广（10+ 种 IDE）
  • 对比 cloudflare/skills：cloudflare/skills 仅 Cloudflare Workers 专用；coding-standards 跨云、跨语言、跨 IDE 通用，平台兼容性远超云厂商官方 Skill
  • 数据来源：affaan-m/everything-claude-code + Conventional Commits 规范

评分依据可追溯至公开来源，每项分数均有明确理由和数据支撑。

🏷️ 标签说明

  • 免费: 开源项目，核心功能完全免费、无强制付费墙；启用 GitHub Sponsors 但不影响 Skill 使用。来源：affaan-m/everything-claude-code
  • 设计模式: 提供架构设计、命名约定、Conventional Commits、模块边界等设计模式指导。来源：coding-standards README
  • 编程: 以 AI 编程辅助为核心功能，专为编码规范、命名约定、提交规范设计。来源：coding-standards README

📋 来源与核验记录

本文基于官方文档和公开资料整理，AI辅助生成，MagicNetWorld 尚未完成独立实测。如有错误或过时信息，请通过 contact@magicnetworld.com 反馈。