AGENTS.md配置文件

项目名称：你的项目名称 技术栈：React, TypeScript, Node.js 主要框架：Next.js 14 代码规范：Airbnb JavaScript Style Guide

**设置能力边界**，告诉AI助手它的职责范围。例如：

```markdown
## 能力范围
- ✅ 可以生成组件和工具函数
- ✅ 可以提供单元测试建议
- ❌ 不处理数据库敏感操作
- ❌ 不生成第三方API密钥

第二步：定制项目规则（15分钟）

定义文件组织结构，让AI助手知道在哪里放置不同类型的代码：

## 文件组织规范
- 页面组件：/pages
- 共享组件：/components
- 工具函数：/utils
- 样式文件：/styles

设置命名约定，统一代码风格：

## 命名规范
- 组件：PascalCase（如UserProfile）
- 函数：camelCase（如formatDate）
- 常量：UPPER_SNAKE_CASE（如API_BASE_URL）
- 接口：I前缀（如IUser）

第三步：测试与优化（持续进行）

创建测试用例，验证配置效果。例如，让AI助手生成一个用户列表组件，检查它是否遵循了你的命名规范和文件放置规则。

建立反馈机制，在团队中收集AI使用体验：

## 配置反馈
- 日期：2023-10-15
- 问题：AI生成的组件缺少PropTypes定义
- 解决方案：添加PropTypes要求到配置文件

场景化设置技巧：让AI助手适应不同开发场景

场景一：快速迭代的创业项目

创业项目通常需要快速试错，这时AGENTS.md应该侧重：

• 允许使用实验性API
• 简化代码审查规则
• 优先考虑开发速度

配置示例：

## 创业项目特殊规则
- 允许使用React新特性（如Server Components）
- 测试覆盖率要求降低至60%
- 优先推荐轻量级依赖库

场景二：企业级安全项目

对于处理敏感数据的项目，AGENTS.md需要强化安全约束：

• 禁止使用不安全的加密算法
• 强制输入验证和输出编码
• 定期提醒安全最佳实践

配置示例：

## 安全要求
- 必须使用bcrypt处理密码（禁止md5）
- API请求必须包含CSRF令牌
- 所有用户输入必须通过validateInput函数验证

场景三：开源项目贡献引导

开源项目可以通过AGENTS.md指导贡献者：

• 提供贡献流程说明
• 定义PR模板
• 明确代码风格要求

配置示例：

## 贡献指南
- PR标题格式：[类型] 简短描述（如[Feature] 添加用户认证组件）
- 必须包含单元测试
- 文档更新与代码变更同步

配置迁移工具：让旧项目快速用上AI助手

如果你想在已有项目中引入AGENTS.md，可以使用项目提供的配置迁移工具：

1. 克隆项目仓库：

git clone https://gitcode.com/GitHub_Trending/ag/agents.md

2. 运行迁移脚本：

cd agents.md
npm run migrate -- --source /path/to/your/project

3. 手动优化建议： 迁移工具会生成基础配置，但你还需要：

• 添加项目特有的业务规则
• 调整工具推荐的默认设置
• 与团队成员一起评审配置内容

团队协作场景的配置模板

以下是一个适合5-10人团队的AGENTS.md协作模板：

# 团队协作AI助手配置

## 团队分工
- 前端组：负责/pages和/components
- 后端组：负责/api和/services
- DevOps组：负责/infrastructure

## 代码审查规则
- 前端代码：至少1名前端成员审查
- 后端代码：至少1名后端成员审查
- 核心功能：需要技术负责人审批

## 会议与同步
- 每日站会：AI助手自动生成进度摘要
- 周会：AI助手整理讨论要点和行动项

与其他配置文件的集成方案

AGENTS.md可以与项目中已有的配置文件协同工作：

ESLint集成

在AGENTS.md中引用ESLint配置：

## 代码质量
- ESLint配置：.eslintrc.js
- 强制规则：no-console, no-unused-vars
- 警告规则：prefer-const, no-var

Git Hooks集成

结合husky实现提交前自动检查：

## 提交规范
- 提交信息格式：<type>(<scope>): <subject>
- 提交前检查：运行lint和单元测试
- 使用工具：husky配置

CI/CD集成

在AGENTS.md中定义CI流程期望：

## CI/CD要求
- 构建时间：不超过10分钟
- 测试覆盖率：不低于80%
- 部署流程：开发→测试→预发布→生产