在 AGENTS.md 里写「提交信息生成」技能:通用编码智能体都能用
开发团队经常要做「提交信息生成」这类事:根据暂存区改动生成规范的提交信息。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。
本文介绍如何在 AGENTS.md 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 提交信息生成(commit-message) |
| 作用 | 根据暂存区改动生成规范的提交信息 |
| 输入 | git diff |
| 输出 | 提交信息 |
| 形态 | 带脚本 |
| 风险 | 低 |
| 适用人群 | 开发团队 |
处理流程分四步:
- 读取改动
- 判断类型与范围
- 写简洁标题
- 在正文说明原因
这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码;风险较低,但输出仍需快速过目再使用。
在 AGENTS.md 中是什么形态
AGENTS.md 是放在仓库根目录、写给编码智能体看的说明文件,多个编码智能体工具都会读取它。把常用流程写成其中的一个小节,就相当于给所有智能体装上同一个技能。
根目录的 AGENTS.md 对整个仓库生效;子目录也可以放自己的 AGENTS.md,就近补充或覆盖说明。
示例配置
AGENTS.md 中的小节示例(示意):
## 提交信息生成(commit-message)
- 何时使用:用户需要根据暂存区改动生成规范的提交信息
- 输入:git diff
- 输出:提交信息
- 步骤:
1. 读取改动
2. 判断类型与范围
3. 写简洁标题
4. 在正文说明原因
- 约束:
- 改写历史、删除分支类操作只给建议,不直接执行。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发团队提出相关请求时能对上号;二是约束部分要写进「改写历史、删除分支类操作只给建议,不直接执行」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在仓库根目录打开(或新建)AGENTS.md
- 新增一个以技能名命名的小节,写清何时使用、输入、步骤与约束
- 引用项目里已有的命令和脚本,不要写不存在的命令
- 让智能体执行一次相关任务,检查是否遵循
- 随代码评审一起维护这个小节
实操:一次完整的运行
假设你在Git 仓库与代码托管平台中发出这样的请求(虚构示例):
用提交信息生成技能处理这份git diff,输出提交信息。
智能体识别到任务与「提交信息生成」相关后,会依次读取改动、判断类型与范围、写简洁标题、在正文说明原因。最终交付提交信息,并在末尾列出需要人工确认的内容。你的工作是对照原始git diff抽查两三处关键信息,确认无误后再使用。
测试与验收
让两个不同的编码智能体分别执行同一任务,对比是否都按小节中的步骤进行。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准git diff,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- AGENTS.md 越写越长,变成没人维护的百科;每个小节保持一屏以内。
- 写了与实际不符的构建或测试命令,智能体会照做并失败。
- 只写了步骤,没写交付格式,导致每次输出的提交信息结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 提交信息生成 · Cursor Rules 版
- 提交信息生成 · MCP 服务 版
- 提交信息生成 · n8n AI Agent 版
- 合并冲突处理 · AGENTS.md 版
- 提交历史摘要 · AGENTS.md 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。