编程开发
给代码仓库写一份有效的 AGENTS.md
把构建命令、代码约定和安全边界写成智能体可执行的仓库说明。
OUTCOME
先看最终成果
一份简洁、准确且经过验证的 AGENTS.md,让编码智能体进入仓库后知道如何修改和检查代码。
STEP BY STEP
跟着步骤完成
- 01
读取现有约定
检查 README、贡献指南、包管理文件、CI 和目录结构,避免重复或编造规则。
- 02
验证关键命令
实际运行安装、开发、测试、检查和构建命令,注明必要的环境条件。
- 03
描述项目地图
说明主要目录、入口、数据流和测试位置,只保留完成修改所需的信息。
- 04
写清操作边界
列出禁止提交的密钥、不可随意修改的生成文件、迁移要求和高风险操作。
- 05
按目录细化
大型仓库只在规则确有差异的子目录添加嵌套 AGENTS.md,避免冲突和冗余。
PROMPT
可直接使用的提示词
请分析当前仓库并起草 AGENTS.md。必须从现有文件和可运行命令中取证,包含:项目概览、目录地图、安装/开发/测试/检查/构建命令、代码风格、测试约定、安全边界和完成定义。不要复制 README 的宣传内容,不要写未经验证的命令;不确定处标记“待确认”。把双大括号中的内容替换为你的真实信息。先补足上下文,再追求表达效果。
QUALITY CHECK
交付前检查
- 所有命令均来自仓库并已验证
- 目录说明与实际结构一致
- 规则简洁且没有互相冲突
- 安全与密钥边界明确
- 说明了修改完成的验证标准
SOURCE
来源与改编说明
- 仓库
- microsoft/skills
- 作者
- Microsoft
- 许可证
- MIT License
- 参考日期
- 2026-09-28
本站依据 MIT 许可参考其仓库上下文组织方式,重新编写为通用中文教程。