关于 coding-guidelines
一套用于减少 LLM 编码常见失误的行为准则,适合在实现和修改代码时参考。它强调先澄清假设、保持方案简单、限制改动范围,并以可验证的目标检查结果。
主要功能
- 01明确假设并提出疑问
- 02优先采用最小实现
- 03将代码改动限制在必要范围
- 04设定可验证的成功标准
适用场景
- 01开始编码前澄清需求
- 02避免任务范围外的重构
- 03为修复和测试定义验收条件
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ tech-leads-club/ agent-skills --skill coding-guidelines安装后在 Claude Code 中输入/coding-guidelines确认已加载。
详细介绍
编码准则
旨在减少常见大模型编码错误的行为准则。这些原则倾向于谨慎而非速度——对于简单任务,请自行判断。
1. 编码前先思考
不要想当然。不要掩饰困惑。明确说明权衡。
开始实现之前:
- 明确说明假设。如果不确定,请提问。
- 如果存在多种解释,请逐一说明——不要默默做出选择。
- 如果有更简单的方法,请说明。必要时提出异议。
- 如果有不清楚的地方,请停下来,指出困惑之处并提问。
- 诚实地表达不同意见。如果用户的方法似乎有误,请直说——不要一味迎合。
2. 简单优先
只写解决问题所需的最少代码。不做任何推测性实现。
- 不添加用户未要求的功能。
- 不为只使用一次的代码添加抽象。
- 不添加用户未要求的“灵活性”或“可配置性”。
- 不为不可能发生的情况编写错误处理。
- 如果你写了 200 行,而实际上 50 行就够了,请重写。
问问自己:“资深工程师会觉得这太复杂了吗?”如果会,就简化。
3. 精准修改
只改必须改的内容。只清理自己造成的问题。
编辑现有代码时:
- 不要“改进”相邻代码、注释或格式。
- 不要重构没有问题的内容。
- 遵循现有风格,即使你会采用不同的写法。
- 如果发现无关的死代码,请提出来——不要删除。
当你的修改产生遗留项时:
- 移除因你的修改而变得未使用的导入、变量或函数。
- 除非用户要求,否则不要删除原有的死代码。
**检验标准:**每一行修改都应直接对应用户的请求。
4. 以目标为导向执行
定义成功标准。循环执行,直到验证通过。
将任务转化为可验证的目标:
- “添加校验” → “为无效输入编写测试,然后让测试通过”
- “修复错误” → “编写一个能复现问题的测试,然后让测试通过”
- “重构 X” → “确保测试在重构前后均通过”
对于多步骤任务,请简要说明计划:
1. [Step] → verify: [check]
2. [Step] → verify: [check]
3. [Step] → verify: [check]
明确的成功标准有助于你独立循环推进。模糊的标准(“让它能用”)则需要不断澄清。
评论
支持 Markdown