📚 工程方法 全难度 📦 community

coding-standards

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

8.4 /10 ★★★★☆
📅 2026-06-15 · 🕒 5 分钟阅读 · 最后更新 2026-06-15 · 来源: community · 分析测评
#standards#linting#conventions
📄 相关文章

📊 评分明细

⚡ 功能完备度
8.4 核心功能齐全
🎯 易用性
8.1 安装即用
🔧 可扩展性
8.7 支持定制和 fork
🔗 生态协同
8.3 可链式调用
🛡️ 稳定性
9 CI 集成验证

🎯 适用场景

standardslintingconventions

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 风格问题更彻底。

常见问题 FAQ

Q1: 这个 Skill 跟 coding-standards 有什么关系?必须装吗?

A: Skill 是给 AI Agent 用的”技能包”,能告诉 Agent 怎么按特定规范工作。不是必须装——如果你的项目规模小、要求不高,不装也能用。但装上能让 Agent 输出的质量更高、更符合最佳实践,推荐装。

Q2: 这个 Skill 适合哪些 AI Agent?Cursor?Claude Code?其他?

A: coding-standards 来自 community,主要面向支持 Skill 机制的 Agent。常见兼容 Agent 包括 Claude Code、Cursor、OpenCode、Windsurf 等。具体兼容性请查 Skill 官方文档。

Q3: 装了这个 Skill 后,会拖慢 Agent 响应吗?

A: 会的——Skill 通常会增加 prompt 长度,导致响应变慢、token 消耗增加。但质量提升明显。建议:1) 只装项目必需的 Skill;2) 用 Skill 启动/加载/卸载机制按需加载;3) 定期清理不用的 Skill。

Q4: 怎么验证 Skill 装对了?

A: 在 Agent 中输入”列出已加载的 Skill”或类似命令。如果 Skill 出现在列表里,说明装对了。然后用 Skill 跑一个相关任务,看输出是否符合 Skill 规范。

Q5: 这个 Skill 有许可证吗?能商用吗?

A: 取决于 coding-standards 的许可证。常见许可证包括 MIT(完全自由)、Apache-2.0(自由但有专利条款)、源可用(可看不能用)、GPL(强开源)。商用前请查仓库 LICENSE 文件。

进阶学习建议

如果想进一步用好 coding-standards,建议按以下路径学习:

第 1 周:熟练使用

  • 完成 3 步快速上手,跑通第一个任务
  • 试 2-3 个不同场景的真实任务
  • 记录”哪些 prompt 有效、哪些没用”——形成自己的 prompt 笔记

第 2 周:理解机制

  • 阅读 Skill 的官方文档(README、SKILL.md)
  • 了解 Skill 的”触发关键词”和”输出格式”
  • 学习”如何用更具体的描述触发 Skill”

第 3-4 周:组合使用

  • 跟其他 Skill 组合(比如代码审查 + 性能优化)
  • 跟其他 Agent 工具组合(Skill + MCP + 自定义脚本)
  • 沉淀团队/个人的 Skill 库

长期:贡献社区

  • 把自定义的 Skill 开源到 GitHub
  • 提 PR 改进现有 Skill
  • 写使用心得分享到 CSDN/掘金/知乎

推荐资源:

避免的坑:

  • 不要装太多 Skill(超过 10 个会拖慢 Agent)
  • 不要把 Skill 装在不兼容的 Agent 上
  • 不要直接复制 Skill 默认 prompt——要根据项目调整
  • 定期 review Skill 库的实用性,清理不用的

参考链接

我的个人推荐(测试编辑 Mnet)

最常用的 1 个核心用法:每天打开 Agent 第一时间加载这个 Skill,既不消耗太多 token 也能规范输出。

最容易踩的坑:别把 Skill 提示词当”开箱即用”的最终答案——它只是给你一个”标准框架”,具体项目还得你自己调整。

适合人群:做过 3+ 个实际项目的开发者,而不是”看一遍文档就完事”的小白。

3 个月使用心得:刚开始用时觉得”规范是约束”,用了 3 个月后才发现”规范是省时间”——避免每次重新决策同样的细节。

推荐配合的工具:Claude Code / Cursor / OpenCode 任选一个主流 Agent 即可,不要在工具选择上纠结太久。

长期价值:这类 Skill 的核心价值不是”立竿见影的输出”,而是”持续一致的质量”——长期用下来,你的项目质量会稳定在专业水平。

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

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 配合使用效果最佳。

参考资料

📦 快速安装

1 npx (推荐) 
npx skills add affaan-m/everything-claude-code --skill coding-standards