AI Skills
create-agentsmd

create-agentsmd

热门

为仓库生成 AGENTS.md 文件的提示

3.6万Star
0Fork
更新于 2026/7/10
获取 Skill源代码

相关 Skills

frontend-testing15万vitest11万subagent-driven-development23万
SKILL.md
readonly只读
name
create-agentsmd
description

为仓库生成 AGENTS.md 文件的提示

创建高质量的 AGENTS.md 文件

你是一个代码代理。你的任务是在此仓库的根目录下创建一个完整、准确的 AGENTS.md 文件，遵循 https://agents.md/ 上的公开指南。

AGENTS.md 是一种开放格式，旨在为编码代理提供有效工作所需的上下文和指令。

什么是 AGENTS.md？

AGENTS.md 是一个 Markdown 文件，作为“代理的 README”——一个专用、可预测的位置，用于提供上下文和指令，帮助 AI 编码代理处理你的项目。它补充了 README.md，包含编码代理需要的详细技术上下文，而这些内容可能会使面向人类的 README 显得杂乱。

关键原则

  • 面向代理：包含针对自动化工具的详细技术指令
  • 补充 README.md：不取代人类文档，而是添加代理特定的上下文
  • 标准化位置：放置在仓库根目录（或 monorepo 的子项目根目录）
  • 开放格式：使用标准 Markdown，结构灵活
  • 生态兼容性：适用于 20 多种不同的 AI 编码工具和代理

文件结构和内容指南

1. 必需设置

  • 在仓库根目录创建文件 AGENTS.md
  • 使用标准 Markdown 格式
  • 无必填字段——根据项目需求灵活结构

2. 应包含的基本部分

项目概述
  • 项目功能的简要描述
  • 如果复杂，提供架构概述
  • 使用的关键技术和框架
设置命令
  • 安装说明
  • 环境设置步骤
  • 依赖管理命令
  • 数据库设置（如适用）
开发工作流
  • 如何启动开发服务器
  • 构建命令
  • 监听/热重载设置
  • 包管理器细节（npm、pnpm、yarn 等）
测试说明
  • 如何运行测试（单元、集成、端到端）
  • 测试文件位置和命名约定
  • 覆盖率要求
  • 使用的特定测试模式或框架
  • 如何运行测试子集或专注于特定区域
代码风格指南
  • 语言特定约定
  • 代码检查和格式化规则
  • 文件组织模式
  • 命名约定
  • 导入/导出模式
构建和部署
  • 构建命令和输出
  • 环境配置
  • 部署步骤和要求
  • CI/CD 管道信息

3. 可选但推荐的部分

安全考虑
  • 安全测试要求
  • 秘密管理
  • 认证模式
  • 权限模型
Monorepo 说明（如适用）
  • 如何处理多个包
  • 跨包依赖
  • 选择性构建/测试
  • 包特定命令
拉取请求指南
  • 标题格式要求
  • 提交前必须的检查
  • 审查流程
  • 提交消息约定
调试和故障排除
  • 常见问题及解决方案
  • 日志模式
  • 调试配置
  • 性能考虑

示例模板

以此作为起始模板，并根据具体项目进行自定义：

# AGENTS.md

## 项目概述

[项目的简要描述、目的和关键技术]

## 设置命令

- 安装依赖：`[package manager] install`
- 启动开发服务器：`[command]`
- 构建生产版本：`[command]`

## 开发工作流

- [开发服务器启动说明]
- [热重载/监听模式信息]
- [环境变量设置]

## 测试说明

- 运行所有测试：`[command]`
- 运行单元测试：`[command]`
- 运行集成测试：`[command]`
- 测试覆盖率：`[command]`
- [特定测试模式或要求]

## 代码风格

- [语言和框架约定]
- [代码检查规则和命令]
- [格式化要求]
- [文件组织模式]

## 构建和部署

- [构建过程细节]
- [输出目录]
- [环境特定构建]
- [部署命令]

## 拉取请求指南

- 标题格式：[组件] 简要描述
- 必需检查：`[lint command]`、`[test command]`
- [审查要求]

## 附加说明

- [任何项目特定上下文]
- [常见陷阱或故障排除提示]
- [性能考虑]

来自 agents.md 的工作示例

以下是来自 agents.md 网站的真实示例：

# 示例 AGENTS.md 文件

## 开发环境提示

- 使用 `pnpm dlx turbo run where <project_name>` 跳转到某个包，而不是用 `ls` 扫描。
- 运行 `pnpm install --filter <project_name>` 将包添加到工作区，以便 Vite、ESLint 和 TypeScript 能够识别它。
- 使用 `pnpm create vite@latest <project_name> -- --template react-ts` 快速创建带有 TypeScript 检查的新 React + Vite 包。
- 检查每个包中 package.json 的 name 字段以确认正确的名称——跳过顶层那个。

## 测试说明

- 在 .github/workflows 文件夹中找到 CI 计划。
- 运行 `pnpm turbo run test --filter <project_name>` 以执行为该包定义的所有检查。
- 从包根目录可以直接调用 `pnpm test`。提交前应通过所有测试。
- 要专注于某一步骤，添加 Vitest 模式：`pnpm vitest run -t "<test name>"`。
- 修复任何测试或类型错误，直到整个套件变绿。
- 移动文件或更改导入后，运行 `pnpm lint --filter <project_name>` 以确保 ESLint 和 TypeScript 规则仍然通过。
- 为你更改的代码添加或更新测试，即使没有人要求。

## PR 说明

- 标题格式：[<project_name>] <标题>
- 提交前始终运行 `pnpm lint` 和 `pnpm test`。

实施步骤

  1. 分析项目结构以了解：

    • 使用的编程语言和框架
    • 包管理器和构建工具
    • 测试框架
    • 项目架构（monorepo、单包等）

  2. 识别关键工作流，通过检查：

    • package.json 脚本
    • Makefile 或其他构建文件
    • CI/CD 配置文件
    • 文档文件

  3. 创建全面的部分，涵盖：

    • 所有基本的设置和开发命令
    • 测试策略和命令
    • 代码风格和约定
    • 构建和部署流程

  4. 包含具体、可操作的命令，代理可以直接执行

  5. 测试指令，确保所有命令按文档工作

  6. 保持专注于代理需要知道的内容，而不是一般项目信息

最佳实践

  • 具体化：包含确切的命令，而不是模糊的描述
  • 使用代码块：用反引号包裹命令以清晰显示
  • 包含上下文：解释为什么需要某些步骤
  • 保持更新：随着项目发展而更新
  • 测试命令：确保所有列出的命令实际有效
  • 考虑嵌套文件：对于 monorepo，在子项目中根据需要创建 AGENTS.md 文件

Monorepo 考虑

对于大型 monorepo：

  • 在仓库根目录放置主 AGENTS.md
  • 在子项目目录中创建额外的 AGENTS.md 文件
  • 最近的 AGENTS.md 文件对给定位置具有优先权
  • 包含包/项目之间的导航提示

最终说明

  • AGENTS.md 适用于 20 多种 AI 编码工具，包括 Cursor、Aider、Gemini CLI 等
  • 格式有意灵活——根据项目需求进行调整
  • 专注于可操作的指令，帮助代理理解和处理你的代码库
  • 这是活的文档——随着项目发展而更新

创建 AGENTS.md 文件时，优先考虑清晰性、完整性和可操作性。目标是让任何编码代理有足够的上下文来有效贡献项目，而无需额外的人类指导。