适用于 Devin 的 AGENTS.md 文件 - Devin Docs

Devin 支持 AGENTS.md —— 这是一种用于为 AI 智能体提供上下文和指示的简单、开放标准。你可以将 AGENTS.md 看作智能体的 README。

创建 AGENTS.md 文件

只需在项目根目录 (或任何其他位置) 放置一个 AGENTS.md 文件。Devin 在开始编写代码之前会先查找该文件。 Devin 会自动将每个 AGENTS.md 文件开头最多 16 KiB (16,384 字节) 的内容纳入其上下文。对于更长的文件，Devin 会收到截断提示，并可按需读取完整文件，但超出上限部分的指示不会自动纳入。请将关键指示放在文件靠前的位置，将始终生效的指导控制在 16 KiB 以内，并将较长或仅适用于特定场景的指导移至技能或所引用的文件中。下面是一个示例：

# AGENTS.md

## 设置命令
- 安装依赖项： `npm install`
- 启动开发服务器： `npm run dev`
- 运行测试：`npm test`
- 构建生产版本：`npm run build`

## 代码规范
- 使用 TypeScript 严格模式
- React 中优先使用函数组件
- 使用 ESLint 和 Prettier 配置
- 遵循约定式提交规范

## 测试指南
- 为所有新函数编写单元测试
- 使用 Jest 测试框架
- 代码覆盖率目标 >80%
- 提交前运行测试

## 项目结构
- `/src` - 主应用代码
- `/tests` - 测试文件
- `/docs` - 文档
- `/public` - 静态资源

## 开发工作流程
- 从 `main` 分支创建功能分支
- 使用 Pull Request 进行代码审查
- 合并前压缩提交记录
- 为新功能更新文档

我们也强烈建议完成仓库设置，以便为 Devin 提供有关如何处理您的代码仓库的上下文。