mcpField
C
core-coding-standards

core-coding-standards

github.com/ravnhq开发16100 次安装21 周前更新
代码仓库

关于 core-coding-standards

core-coding-standards 是一项提供实用编码原则的技能,强调简洁、职责清晰和明确处理错误。它帮助 Agent 在审查或修改代码时给出可执行指导,并避免过早抽象和优化。

主要功能

  1. 01倡导简洁且职责明确的代码
  2. 02采用描述性命名
  3. 03控制重复与抽象
  4. 04要求明确处理错误
  5. 05提供应用规范的工作流程

适用场景

  1. 01检查服务中的不必要重复
  2. 02在保持行为不变时重构
  3. 03在任务中贯彻一致的编码原则

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/ravnhq/ai-toolkit --skill core-coding-standards

安装后在 Claude Code 中输入/core-coding-standards确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

rules/
_sections.md
comment-why-not-what.md
org-no-premature-abstraction.md

详细介绍

原则

  • 保持简单(KISS)——优先选择可行的最简单方案
  • 不要重复自己(DRY)——发现三处重复时再提取,而不是更早
  • 单一职责——每个模块/函数只做一件事
  • 使用描述清晰、能体现意图的名称
  • 文件和文件夹使用 kebab-case
  • 函数应有明确的输入和输出,并尽量减少副作用
  • 保持函数规模适中——当逻辑需要注释才能解释时,就提取出来
  • 删除无用代码——不要将其注释掉
  • 绝不要默默吞掉错误
  • 优化前先测量——不要过早进行性能优化
  • 不要过早抽象——等出现三个具体的重复后再提取

规则

详细模式请参阅规则索引。

示例

正向触发

用户:“审查这项服务并消除重复,同时保持行为不变。”

预期行为:使用 core-coding-standards 指引,遵循其工作流,并返回可执行的结果。

非触发

用户:“生成一句一次性的产品营销标语。”

预期行为:不要优先使用 core-coding-standards;选择更相关的技能,或不使用该技能直接完成。

故障排查

技能未触发
  • 错误:未按预期选择该技能。
  • 原因:请求措辞与描述中的触发条件不够匹配。
  • 解决方案:使用描述中的明确领域/任务关键词重新表述,然后重试。
指引与另一项技能冲突
  • 错误:同一任务中多项技能的指令相互冲突。
  • 原因:已加载技能的适用范围重叠。
  • 解决方案:指出当前步骤以哪项技能为准,并优先遵循其工作流。
输出过于笼统
  • 错误:结果缺少具体、可执行的细节。
  • 原因:任务输入未提供上下文、约束或目标格式。
  • 解决方案:补充具体约束(环境、范围、格式、成功标准),然后重新运行。

工作流

  1. 判断请求是否明确符合 core-coding-standards 的适用范围和触发条件。
  2. 应用技能规则和所引用的指引,生成具体结果。
  3. 根据约束检查输出质量;若仍有不足,使用明确假设再完善一次。

评论

支持 Markdown