name: agents-mddescription: This skill should be used when the user asks to “create AGENTS.md”, “update AGENTS.md”, “maintain agent docs”, “set up CLAUDE.md”, or needs to keep agent instructions concise. Enforces research-backed best practices for minimal, high-signal agent documentation.risk: criticalsource: community维护 AGENTS.mdAGENTS.md 是面向代理的权威文档。保持简洁——代理足够能干不需要手把手的指导。目标是少于 60 行绝不超过 100 行。随着文档长度增加执行指令的质量会下降。何时使用用户请求创建、更新或审计AGENTS.md或CLAUDE.md。该项目需要从实际工具链和仓库布局中提炼出的简明、高信号的代理指令。现有的代理文档太长、重复或者偏离了实际项目的规范。文件设置在项目根目录创建AGENTS.md创建符号链接ln -s AGENTS.md CLAUDE.md写作前分析项目以了解哪些内容属于该文件包管理器— 检查锁文件pnpm-lock.yaml、yarn.lock、package-lock.json、uv.lock、poetry.lockLinter/格式化程序配置— 查找.eslintrc、biome.json、ruff.toml、.prettierrc等。不要在 AGENTS.md 中重复这些内容CI/构建命令— 检查Makefile、package.json脚本以及 CI 配置中的标准命令Monorepo 指示器— 检查pnpm-workspace.yaml、nx.json、Cargo workspace 或子目录中的package.json文件现有的约定— 检查现有的 CONTRIBUTING.md、docs/ 或 README 模板写作规则标题 项目符号— 无段落代码块— 用于命令和模板仅作参考不要嵌入— 指向现有文档“有关设置请参阅CONTRIBUTING.md” 或 “遵循src/api/routes/中的模式”无废话— 无介绍、结论或客套话信任能力— 省略明显的上下文优先使用文件范围的命令— 每个文件的测试/代码检查/类型检查命令优于全项目构建不要重复使用代码检查工具— 代码风格存在于代码检查工具配置中而不是 AGENTS.md必填部分软件包管理器仅使用哪个工具和快捷键## Package Manager Use **pnpm**: pnpm install, pnpm dev, pnpm test文件范围命令逐文件命令比完整项目构建更快、更便宜。可用时请始终包括## File-Scoped Commands | Task | Command | |------|---------| | Typecheck | pnpm tsc --noEmit path/to/file.ts | | Lint | pnpm eslint path/to/file.ts | | Test | pnpm jest path/to/file.test.ts |提交归属始终包含此部分。代理应使用他们自己的身份## Commit Attribution AI commits MUST include:联合作者 代理模型的名称和署名栏Example: Co-Authored-By: Claude Sonnet 4 noreplyexample.com关键惯例项目特定模式代理必须遵循。保持简短。可选部分仅在真正需要时添加API 路由模式显示模板不解释命令行界面命令表格格式文件命名规范项目结构提示指向关键文件标记需避免的遗留代码单一代码库覆盖子目录AGENTS.md文件覆盖根目录反模式省略这些“欢迎来到……” 或 “本文件说明……”“你应该……”或“记得……”Lint器/格式化器规则已在配置文件中.eslintrc、biome.json、ruff.toml列出已安装的技能或插件代理会自动发现这些当存在文件范围的替代项时完整的全项目构建命令明显的指示“运行测试”“编写干净的代码”解释原因只说是什么长篇散文段落示例结构# Agent Instructions ## Package Manager Use **pnpm**: pnpm install, pnpm dev ## Commit Attribution AI commits MUST include:联合作者 代理模型的名称和署名## File-Scoped Commands | Task | Command | |------|---------| | Typecheck | pnpm tsc --noEmit path/to/file.ts | | Lint | pnpm eslint path/to/file.ts | | Test | pnpm jest path/to/file.test.ts | ## API Routes [Template code block] ## CLI | Command | Description | |---------|-------------| | pnpm cli sync | Sync data |限制仅当任务明确符合上述描述的范围时才使用此技能。不要将输出视为环境特定验证、测试或专家审查的替代品。如果缺少所需的输入、权限、安全界限或成功标准请停下来并要求澄清。