务实 AI 洁净代码规范
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @org-eyw2ohcx/sundial-org-awesome-openclaw-skills-clean-code。
技能介绍
问题从哪来
用大模型改仓库时,常见输出是:函数动辄上百行、utils.ts 里只有一个方法、改一处却漏掉依赖文件的 import,或者先写一大段「编程课」再动刀。读者要的是能合进 CI 的 diff,不是文档式说教。
技能如何约束行为
本技能把 Clean Code 与 务实交付 绑在一起,用表格化规则直接写进 system prompt:
- 设计原则:
SRP、DRY、KISS、YAGNI与 Boy Scout(离开时比发现时更干净)。 - 命名:变量表达意图(如
userCount),函数用「动词 + 名词」,布尔用疑问式(isActive);需要注释才能读懂名字 → 改名。 - 函数:理想 5–10 行、上限约 20 行;单一职责、单一抽象层级;参数尽量 0–2 个,最多 3 个;避免意外改动入参。
- 结构:Guard clause 提前返回、嵌套不超过约 2 层、小函数组合而非 God function。
- AI 交互风格:要功能就写功能;报 bug 先修再少解释;需求不清先问、不猜。
- 改文件前:自问谁 import 本文件、本文件 import 谁、哪些测试覆盖、是否共享组件;同一任务内同步改依赖,不留断链。
- 收尾自检:目标是否满足、必要文件是否都改、能否运行、lint/TS 是否过、边界是否漏。
- 验证脚本:各 agent 只跑自己技能映射的脚本;输出须 读取 → 汇总 → 询问用户 再修,禁止无视输出或擅自自动修复。
适用边界
这是编码与协作流程规范,不替代领域建模或安全审计的专业技能;文中列出的 ux_audit.py、lint_runner.py 等路径属于多 agent 仓库约定,你的项目若无 .agent/skills/ 结构,应把「跑哪条脚本」映射到本地等价检查,而不要机械复制路径。
使用场景
- 用户报线上 bug,要求模型直接改代码并同步所有被 import 的调用方,而不是先写长文解释根因
- Refactor 时发现单文件函数超过 20 行或嵌套过深,需要按 Guard clause 与 SRP 拆分并保持 diff 可过 lint
- 多 agent 分工仓库里,frontend-specialist 完工后只跑本技能映射的 UX/A11y 脚本,并把输出汇总给用户确认
- 需求表述模糊时,约束助手先澄清再实现,避免 YAGNI 式提前堆未使用功能
适合人员
- 维护 monorepo、经常让 Copilot/Claude 批量改多文件的资深工程师,怕漏改依赖导致 CI 红
- 带「专用 agent」目录(如 frontend/backend/test 分工)的平台同学,需要统一「谁跑哪条校验脚本」
- 写 Code Review 清单的技术负责人,想把 SRP/命名/小函数等规则固化进 AI 助手默认行为
- 接外包或遗留代码清理的独立开发者,希望模型少建 `utils`、少写上帝函数、直接交可合并补丁