用于减少编码任务中常见失误的行为准则技能。当编写、审查、调试、修复Bug、重构或补充测试代码时使用,遵循四条核心行为准则:最小化上下文依赖、避免字符串拼接、原子化提交、每次只改一件事。源自Karpathy的LLM编程最佳实践。
Karpathy代码指南:减少LLM编程错误的四大行为准则
【适用场景】
Step 1:编写新代码
当需要编写新功能代码时,遵循最小化上下文依赖和避免字符串拼接原则。Step 2:代码审查
在进行代码审查时,检查是否违反了四条核心行为准则。Step 3:Bug修复
当修复Bug时,遵循原子化提交原则,确保每次修复只做一件事。Step 4:重构代码
当进行代码重构时,每次只改一件事,避免多动机修改。【操作步骤】
准则一:最小化上下文依赖 编写代码时尽量减少对上下文的依赖,使代码能够独立理解。
准则二:避免字符串拼接 不要用字符串拼接方式构建代码结构,使用结构化方法。
准则三:原子化提交 每次提交只包含一个逻辑变更,便于追溯和回滚。
准则四:每次只改一件事 重构或修改时,每次只聚焦一个改变点。
【代码模板】
反模式(应避免) ```python
字符串拼接构建代码
code = "def " + func_name + "(" + ", ".join(args) + "):\n" + body多动机修改
def refactor_and_fix(input):同时做两件事
return fix_bug(process_data(input)) ```正确模式 ```python
结构化代码构建
def build_function(func_name, args, body): return FunctionDef(func_name, args, body)单一职责
def process(input): return process_data(input)def fix(input): return fix_bug(process(input)) ```
【复盘要点】
核心价值:这四条准则能显著减少LLM在代码生成中的常见错误。
适用判断:简单代码修改可灵活处理,复杂逻辑严格遵循。
审查重点:代码审查时重点关注是否违反了四条准则。
来源:GitHub https://github.com/mofan212/codex-profile/blob/master/profile/skills/coding-guidelines/SKILL.md