Create Agentsmd

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

hacxy c2763c2 2.1 KB Updated

File contents

Create AGENTS.md

为当前仓库创建 AGENTS.md — 一份面向 AI coding agent 的「README」,放在仓库根目录。参考 https://agents.md/ 的公开规范。

核心原则

  • Agent 视角 — 写给自动化工具,不是写给人
  • 补充 README — 不替代人类文档,而是补充 agent 需要的技术上下文
  • 标准化位置 — 根目录(monorepo 放子项目根目录)
  • 开放格式 — 标准 Markdown,结构灵活

必需章节

项目概览

  • 一句话说明项目做什么
  • 关键技术栈和框架
  • 复杂项目附架构概览

环境搭建

  • 安装依赖的命令
  • 环境变量配置
  • 数据库初始化(如需要)

开发工作流

  • 启动开发服务器的命令
  • 构建命令
  • 热重载/watch 模式
  • 包管理器特定命令

测试

  • 运行全部测试的命令
  • 运行单元/集成/e2e 测试的命令
  • 测试覆盖率要求
  • 测试文件命名惯例
  • 运行单个测试或聚焦特定区域的方式

代码风格

  • 语言特定惯例
  • Lint 和格式化规则
  • 文件组织模式、命名惯例

构建与部署

  • 构建命令和输出目录
  • CI/CD 流水线信息
  • 环境相关构建差异

推荐章节

  • 安全 — 密钥管理、认证模式、权限模型
  • Monorepo 指引 — 跨包依赖、选择性构建/测试
  • PR 规范 — 标题格式、必跑检查、review 流程
  • 调试与排障 — 常见问题及解决方案

编写要求

  • 具体 — 用精确命令,不要模糊描述
  • 代码块 — 命令用反引号包裹
  • 说明原因 — 解释为什么需要某些步骤
  • 保持更新 — 随项目演进同步更新
  • 验证命令 — 确保列出的命令都能实际运行

Monorepo 策略

  • 根目录放主 AGENTS.md
  • 子项目目录各放一份
  • 最近的 AGENTS.md 对当前位置优先
  • 包含跨包导航提示

完成标准: AGENTS.md 已写入仓库根目录,覆盖上述所有必需章节,每个命令都可直接执行,无占位文本。

hacxy/skills/tree/main/skills/create-agentsmd commit c2763c246d

Frequently asked questions

npx skillmds@latest add hacxy/create-agentsmd