agentleFS
mike22890mike22890/opencode-skills-en/skills/code-mastery/SKILL.md

code-mastery

Skill1 starsChanged 59 days agoMITView on GitHub

代码质量与审美的综合指南——命名、函数、文件、注释、错误处理、性能。当写代码、重构、改命名、加注释、加错误处理、优化性能、写测试、debug、写脚本、写 API、写后端、写前端、写 CLI、写工具、代码 review、代码审查、让代码更简洁、更优雅、更易读时使用。

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

Files
SKILL.md

Code Mastery

何时触发(看到就调本 skill)

写代码(强触发)

  • 写代码 / 实现功能 / 写函数 / 写方法 / 写类 / 写组件
  • 写 API / 写后端 / 写前端 / 写 CLI / 写脚本 / 写工具
  • 写 SQL / 写数据库 / 写 ORM
  • 写测试 / 写单测 / 写集成测试

改代码(强触发)

  • 重构 / 简化 / 优化性能 / 改命名 / 改注释
  • 加错误处理 / 加边界处理 / 加类型
  • lint / format / prettier / eslint
  • debug / 修 bug / 排查问题

通用触发

  • "代码质量" / "写得简洁点" / "不要啰嗦" / "性能" / "效率" / "省钱"
  • "clean code" / "refactor" / "optimize" / "simplify"
  • "太乱了" / "看不懂" / "难维护" / "代码臭" / "屎山"

关键词命中即触发:写代码、实现、重构、简化、优化、命名、注释、性能、debug、API、后端、前端、SQL、test、lint、format、review。

速记 8 条(写之前过一遍)

  1. 命名:窄 / 意图明确 / 不缩写 / 不万能词 / 不重复上下文
  2. 函数:≤ 30 行(理想 ≤ 10)/ 0-2 参数 / 早返回 / 无副作用
  3. 文件:≤ 200 行 / 单职责 / import 顺序统一
  4. 注释:解释"为什么",不是"是什么" / 不复述 / 删过时的
  5. 性能:O(n) > O(n²) / 缓存 / 不在循环里 new / 不阻塞
  6. 错误:边界完整(空/超时/异常)/ 不吞 / 带信息
  7. 格式:prettier + 行宽 100 / 不争论格式 / 自动化
  8. 避免:过度抽象 / 万能 helper / 三层 wrapper / 嵌套地狱 / 巨文件

强制自检清单(commit 前逐条对照)

  • 命名意图明确,没用 data/info/item/manager/handler/util/helper
  • 函数 ≤ 30 行,0-2 参数
  • 没有 3 层以上 if 嵌套(用早返回)
  • 注释解释"为什么",不复述代码
  • 没有吞异常(catch 后要么处理要么抛出)
  • 没有 N² 循环(除非必要 + 注释说明)
  • 没有在循环里 new 对象
  • 没有万能 utils.ts(拆成具体模块)
  • 没有过度抽象(3 次重复再抽象,Rule of Three)
  • 文件 ≤ 300 行(超过就拆)
  • 自己看 5 秒觉得"简单"

完成本 skill 后做的事

调阅 reference.md 中相关章节(按场景):

用户说加载 reference.md 章节
命名 / 改名字 / 变量名/ 函数名/ 起名/ 重命名「1. 命名」
写函数 / 改函数 / 函数设计/ 参数/ 返回值/ 纯函数「2. 函数」
组织文件 / 拆模块 / 目录结构/ 模块化/ 拆分/ 架构「3. 文件与模块」
写注释 / 注释规范/ 文档/ 说明「4. 注释」
性能 / 优化 / 慢/ 卡顿/ 内存/ 算法/ 复杂度「5. 性能 / 省钱」
错误处理 / debug / 报错/ 异常/ 边界/ 空值/ 排查「6. 错误处理」
格式 / lint / 代码风格/ 格式化/ prettier「7. 格式 / 视觉」
AI 代码味 / 重构 / 代码审查/ review/ 坏味道「8. 反 AI 代码味」「9. 重构信号」

与其他 skill 的关系

Skill角色在链中位置
code-mastery(本 skill)大师标准 / 指挥原则[1] 起点,必调
simplify自动简化(单文件内)[2]
code-refactor-astAST 重构(跨文件/复杂结构)[3]
db-schema-designer数据库 schema单独使用
aesthetics视觉审美与本 skill 互补(不是同链)

链式触发流程(核心规则,所有代码任务必须遵守)

[1] code-mastery       ← 找标准 / 大师审美(本 skill,**必调**)
   ↓
[2] simplify           ← 自动简化能处理的(命名清理、控制流清晰)
   ↓
[3] code-refactor-ast  ← 复杂结构变换(拆函数、跨文件、AST)
   ↓
[4] /code-review       ← 人工确认 / 兜底审查

触发规则(按 Mike 的话)

Mike 说走哪条
写代码 / 实现 / 写函数 / 写类 / 写 API[1]
简化 / 重写 / 清理 / 改名[1] + [2]
重构 / 拆解 / AST / extract / 跨文件[1] + [2] + [3]
代码审查 / review[4]
任何代码任务完成后主动走 [4] 兜底

铁律

  • ❌ 不跳过 step 1(不直接调 simplify / code-refactor-ast)
  • ❌ 不跳级(code-refactor-ast 必须先经过 simplify 评估)
  • ✅ 任何代码任务完成后主动调 /code-review 兜底
  • ✅ 顺序固定:[1] → [2] → [3] → [4]

精准触发

  • 用户说"代码审查" / "code review" → 走 [4] /code-review 命令
  • 用户说"重构" / "refactor" → 走 [1] + [2] + [3] 完整链
  • 用户说"简化" / "simplify" → 走 [1] + [2]
  • 用户说"性能优化" / "optimize" → 调本 skill 第 5 章 + [4] 兜底
  • 用户说"debug" / "修 bug" → 调本 skill 第 6 章错误处理 + [4]

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.