name: init description: 为仓库(或子目录)创建简洁、仓库特定的AGENTS.md贡献指南。当用户运行/init时使用。 triggers:
- /init
初始化 AGENTS.md
当用户请求为当前仓库搭建 AGENTS.md 文件(AI代理的项目指南)时使用此技能。
目标路径规则
/init: 在仓库根目录创建AGENTS.md。/init <路径>: 在指定路径范围内创建AGENTS.md。- 如果
<路径>是目录,则写入<路径>/AGENTS.md。 - 如果
<路径>以.md结尾,则将其视为完整的输出文件路径。
- 如果
切勿静默覆盖现有文件。如果目标文件已存在,询问用户是否要 (a) 保留它,(b) 编辑它,或 © 替换它。
工作流
-
检查仓库以定制指南
- 浏览顶级结构(
ls、find -maxdepth 2)。 - 阅读主要文档(
README*、CONTRIBUTING*、DEVELOPMENT*、Makefile)。 - 识别构建工具和常用命令(
pyproject.toml、package.json、CI配置)。 - 定位测试以及如何运行它们(
tests/、工作流YAML、任务运行器)。
- 浏览顶级结构(
-
编写简洁的
AGENTS.md使用以下规范。 -
在目标位置创建文件。
AGENTS.md 规范(灵感来自Codex /init)
- 文档标题:
# 仓库指南。 - 使用Markdown标题(
##)组织部分。 - 保持简洁:200–400字。
- 保持解释简短、直接且特定于仓库。
- 优先使用具体示例(命令、目录路径、命名模式)。
推荐部分(根据需要调整)
- 项目结构与模块组织
- 构建、测试和开发命令
- 编码风格与命名约定
- 测试指南
- 提交与拉取请求指南
- 可选:安全与配置提示、架构概述、代理特定说明
内容指南
- 只包括对未来任务广泛有用的信息(避免一次性问题的细节)。
- 如果仓库中已包含嵌套的
AGENTS.md文件,简要提及更深层嵌套的文件在目录树中覆盖较广泛的文件。