[项目名称] AGENTS.md指南

[项目名称] AGENTS.md指南

【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md

开发环境配置

• 使用pnpm dlx turbo run where <项目名称>快速定位工作区中的特定包
• 运行pnpm install --filter <项目名称>为指定项目添加依赖
• 通过pnpm create vite@latest <项目名称> -- --template react-ts创建新的React + Vite项目

测试与验证流程

• 在项目根目录执行pnpm test运行所有测试用例
• 使用pnpm turbo run test --filter <项目名称>运行特定包的测试
• 修复所有类型错误和测试失败后再提交代码

### 环境配置的最佳实践 💡 **关键提示**：始终在正确的目录层级执行命令。在项目根目录运行`pnpm install`，或在需要时为特定项目使用`--filter`参数。 > **专业建议**：创建`.nvmrc`文件指定Node.js版本，确保团队成员和AI代理使用相同的开发环境，避免版本冲突问题。 ### 测试驱动的开发流程 现代AI辅助开发强调**测试优先**的方法。AGENTS.md应该明确指导AI代理： 1. **测试执行顺序**：先运行类型检查，再执行单元测试 2. **错误处理策略**：优先修复类型错误，再处理逻辑错误 3. **测试覆盖率要求**：为新代码添加相应的测试用例 ```bash # 运行特定测试模式 pnpm vitest run -t "用户认证测试" # 检查代码质量 pnpm lint --filter <项目名称> # 确保所有测试通过 pnpm turbo run test --filter <项目名称>

高级配置与工作流优化

多项目管理策略

在包含多个项目的大型工作区中，AGENTS.md应该提供智能导航指令：

## 工作区导航指南 - 使用 `turbo run where` 命令快速查找项目位置 - 避免手动浏览目录树，提高AI代理的效率 - 为每个子项目维护独立的依赖管理策略

持续集成配置

AGENTS.md应该集成CI/CD工作流指导：

## CI/CD集成 - 检查 `.github/workflows` 目录中的CI计划 - 提交前确保所有测试通过 - 遵循PR标题格式：`[<项目名称>] <描述性标题>`

这张图片展示了AGENTS.md格式的技术生态影响力，涵盖了从OpenAI Codex到GitHub Copilot等主流人工智能编码工具。图片清晰地展示了该标准化开发指南格式如何被超过60,000个开源项目和代理框架采用，形成了统一的人工智能辅助开发标准。

常见问题与故障排除

依赖管理问题

问题现象：依赖安装位置错误或版本冲突解决方案：定期清理node_modules并重新安装依赖：

# 清理并重新安装依赖 rm -rf node_modules && pnpm install

开发服务器配置

关键原则：在AI代理会话中始终使用开发服务器模式：

# 正确的开发命令 npm run dev # 或 pnpm dev, yarn dev # 避免在代理会话中使用 npm run build # 这会禁用热重载功能

💡重要提醒：如果开发服务器出现异常，重启开发服务器比运行生产构建更安全可靠。

类型系统集成

确保TypeScript配置与AI代理工作流兼容：

{ "compilerOptions": { "strict": true, "noImplicitAny": true, "skipLibCheck": true } }

扩展应用与自定义配置

项目特定的AGENTS.md定制

每个项目可以根据其技术栈和团队需求定制AGENTS.md：

## 项目特定配置 - 数据库迁移命令 - 环境变量设置流程 - 部署前检查清单 - 代码审查标准

【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md