项目名称的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 project_name快速定位项目运行pnpm install --filter project_name安装项目依赖使用pnpm create vitelatest project_name创建新项目测试指南运行pnpm test执行项目测试修复所有类型错误和测试失败修改代码后运行pnpm lint确保代码规范提交规范PR标题格式[project_name] 标题提交前确保所有测试通过更新相关文档## 如何实施AGENTS.md最佳实践 ### 基础配置步骤 **第一步创建AGENTS.md文件** 在项目根目录创建AGENTS.md文件包含以下基础信息 bash # 创建基础AGENTS.md文件 echo # 项目名称 - AGENTS.md AGENTS.md echo AGENTS.md echo ## 开发环境配置 AGENTS.md echo - 项目使用Node.js版本$(node --version) AGENTS.md echo - 包管理器$(which pnpm /dev/null 21 echo pnpm || echo npm) AGENTS.md第二步添加项目特定指南根据项目特点添加具体指导## 项目架构说明 - 前端React TypeScript Vite - 后端Node.js Express - 数据库PostgreSQL ## 开发工作流 1. 从main分支创建功能分支 2. 运行开发服务器pnpm dev 3. 编写测试用例 4. 提交前运行完整测试套件 ## 常见问题解决 - 如果热重载失效重启开发服务器 - 类型错误优先修复再处理逻辑问题 - 依赖冲突时删除node_modules重新安装大型项目的分层配置对于包含多个子项目的Monorepo架构AGENTS.md支持分层配置project-root/ ├── AGENTS.md # 根项目通用指南 ├── packages/ │ ├── frontend/ │ │ └── AGENTS.md # 前端特定指南 │ ├── backend/ │ │ └── AGENTS.md # 后端特定指南 │ └── shared/ │ └── AGENTS.md # 共享库指南分层配置优势每个子项目可以有特定配置AI助手自动读取最近的AGENTS.md文件避免配置冲突和重复支持项目特定的开发模式常见技术挑战与解决方案问题1AI助手不理解项目结构症状AI助手无法正确导航项目目录频繁使用ls命令扫描文件系统。解决方案## 项目导航指南 - 使用pnpm dlx turbo run where package_name快速定位包位置 - 避免使用ls命令扫描目录树 - 项目结构src/包含源代码tests/包含测试文件问题2依赖管理混乱症状AI助手在错误的位置安装依赖导致构建失败。解决方案## 依赖管理规范 - 始终在项目根目录运行pnpm install - 使用--filter参数为特定包安装依赖 - 锁定文件更新后重启开发服务器问题3测试执行不一致症状AI助手运行错误的测试命令或忽略测试失败。解决方案## 测试执行流程 1. 运行完整测试套件pnpm test 2. 修复所有类型错误 3. 修复所有测试失败 4. 运行代码检查pnpm lint 5. 添加或更新相关测试用例高级配置技巧集成现有AI工具AGENTS.md与主流AI开发工具无缝集成Aider配置# .aider.conf.yml read: AGENTS.mdGemini CLI配置// .gemini/settings.json { agentGuidelines: AGENTS.md }性能优化建议开发服务器管理始终使用npm run dev或pnpm dev、yarn dev进行开发禁止在AI会话中运行npm run build这会禁用热重载依赖更新后重启开发服务器缓存策略AI助手应利用构建缓存避免重复安装依赖合理使用TurboRepo的缓存机制错误处理最佳实践类型错误优先先修复所有TypeScript类型错误再处理逻辑错误最后优化代码风格测试失败处理理解测试失败的根本原因修复代码而不是修改测试除非测试本身有误确保所有测试在提交前通过避坑指南常见配置错误错误1在错误目录运行命令错误做法在项目根目录运行pnpm test导致所有子项目测试都被执行。正确做法# 进入目标项目目录 cd packages/frontend # 运行该项目测试 pnpm test # 或者使用过滤功能 pnpm turbo run test --filter frontend错误2忽略热重载失效问题开发服务器热重载失效后继续开发。解决方案## 开发服务器维护 - 热重载失效时立即重启开发服务器 - 避免在开发过程中运行生产构建 - 定期清理.next缓存目录错误3配置信息过时问题AGENTS.md文件未随项目更新。维护策略将AGENTS.md纳入代码审查流程项目架构变更时更新AGENTS.md定期检查配置的准确性实际应用场景新成员快速上手当新开发者或AI助手加入项目时AGENTS.md提供环境配置快速搭建开发环境工作流程了解项目开发规范测试策略掌握质量保障要求部署流程了解发布步骤多工具协作环境在团队使用多种AI编码工具时AGENTS.md确保一致性所有工具使用相同的项目指南效率减少重复配置时间质量统一的代码标准和测试要求开源项目维护对于开源项目AGENTS.md帮助贡献者理解项目架构和设计决策遵循贡献规范正确运行测试套件提交符合标准的PR迁移现有项目到AGENTS.md逐步迁移策略第一步创建基础AGENTS.md从现有文档中提取核心信息开发环境要求构建和测试命令代码风格指南贡献规范第二步向后兼容为现有工具创建符号链接# 重命名现有文件并创建符号链接 mv AGENT.md AGENTS.md ln -s AGENTS.md AGENT.md【免费下载链接】agents.mdAGENTS.md — a simple, open format for guiding coding agents项目地址: https://gitcode.com/GitHub_Trending/ag/agents.md创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考