原作者 Fabien Sanglard · 原文发布于 2026 年 8 月 21 日
阅读英文原文《My agent.md to improve LLM-assisted code quality》
Sanglard 在审查 AI 生成的代码时,发现自己在不同会话里反复提同样的意见。他把这些反馈写进项目的 agent.md,例如让修复从一个能复现问题的失败测试开始。这样一来,他可以把更多审查时间花在架构和设计上。
他也提到,长会话里模型有时会逐渐偏离已有规则。他的做法是为每个功能开一个短会话,或在发现偏离时请助手重新读取规则。
agent.md 双语要点
阅读 Fabien Sanglard 的英文 agent.md 原文件
中文要点
- 注释、提交信息和回复直接说重点,省去夸张和恭维。
- 把反复出现、有特定含义或由规范规定的值提取为命名常量或枚举。用提前返回和
continue减少嵌套,单行if也加花括号。 - 函数名少于 30 个字符。用枚举替代布尔开关参数,用空行分隔逻辑段,简短说明代码做什么、为什么这样做。
- 成员默认私有,改为
internal或public前先获明确同意。把底层操作封装起来,每层只调用紧邻的下一层。 - 改动限于当前任务。修复前先写复现测试,看到它失败后再修,最后重跑确认通过。
- 提交标题以大写字母开头,用祈使句,省略句号。目标 50 字符,上限 72。用空行分隔正文,正文按 72 字符折行,交代改了什么、为什么改。
English summary
- Get to the point in comments, commit messages, and replies. Skip superlatives and flattery.
- Use named constants or enums for recurring, meaningful, or spec-defined values. Flatten nesting with early exits and
continue. Brace even single-lineifblocks. - Keep function names under 30 characters. Use enums for options passed as boolean flags. Separate logical blocks and briefly explain their purpose and rationale.
- Default to private members and get explicit approval before making them
internalorpublic. Encapsulate low-level operations and call only the layer directly below. - Limit edits to the task. For a bug, reproduce it with a failing test, make the fix, then rerun the test.
- Use a capitalized, imperative commit subject without a period. Aim for 50 characters and cap it at 72. After a blank line, explain what changed and why, wrapping at 72.