AGENTS.md配置文件

1. 项目元数据

• 技术栈: React 18+, TypeScript 5.0+, Node.js 18+
• 架构模式: 组件驱动开发(CDD), 状态管理使用Redux Toolkit

2. 能力配置

• 代码生成: 启用组件生成、API调用生成、测试用例生成
• 代码分析: 启用性能优化建议、安全漏洞检测

3. 约束规则

• 命名规范: 组件采用PascalCase, 函数采用camelCase
• 安全约束: 禁止直接使用eval(), 限制localStorage存储敏感数据

4. 环境适配

• 开发环境: 优先代码生成速度
• 生产环境: 优先性能优化和安全检查

*表1：AGENTS.md配置框架核心要素及作用*

| 配置层级 | 核心作用 | 关键配置项 |
|---------|---------|-----------|
| 项目元数据 | 建立技术基础认知 | 技术栈版本、架构模式、依赖管理策略 |
| 能力配置 | 定义AI功能边界 | 启用/禁用特定AI能力、设置能力参数 |
| 约束规则 | 规范代码生成行为 | 命名规范、安全规则、性能标准 |
| 环境适配 | 实现场景化调整 | 环境变量、场景优先级、工具链适配 |

### 实施步骤：四阶段配置构建流程

#### 阶段一：项目特征提取（1-2小时）

1. **技术栈清单梳理**
   - 列出核心框架及版本（如React 18.2.0）
   - 记录构建工具链（如Vite 5.0、ESLint 8.56.0）
   - 整理架构约束文档（如状态管理方案、API设计规范）

2. **编码规范收集**
   - 提取ESLint和Prettier配置规则
   - 整理团队代码审查 checklist
   - 记录常见架构决策（如组件拆分原则、状态管理边界）

#### 阶段二：基础配置编写（2-3小时）

1. 创建AGENTS.md文件，放置于项目根目录
2. 填充项目元数据章节，明确技术栈约束
3. 配置核心能力开关，禁用项目不需要的AI功能
4. 定义基础编码规则，包括命名规范和文件组织结构

```markdown
## 约束规则
### 命名规范
- **组件文件**: PascalCase + .tsx (如 UserProfile.tsx)
- **工具函数**: camelCase + .ts (如 formatDate.ts)
- **CSS模块**: 文件名与组件相同 + .module.css (如 Button.module.css)

阶段三：场景化规则配置（3-4小时）

1. 为开发/测试/生产环境分别配置规则集
2. 设置规则优先级，处理规则冲突
3. 添加项目特定场景配置（如API调用格式、状态管理模式）

阶段四：验证与优化（持续过程）

1. 通过典型开发任务测试配置效果
2. 收集团队使用反馈，调整规则细节
3. 定期更新配置以适应项目演进

实践：AI助手配置的行业应用与最佳实践

痛点剖析：不同场景的配置挑战

各类型项目在AI助手配置方面面临独特挑战：开源项目需要平衡灵活性与规范性，企业应用强调安全合规，个人项目则注重配置简易性。有效的配置策略必须考虑这些场景差异。

技术解析：配置模板与校验工具

AGENTS.md社区提供了三类基础配置模板，可根据项目类型选择适配：

1. 初创项目模板（轻量级配置）

# AGENTS.md
## 项目元数据
- 技术栈: React 18, TypeScript 5.0
- 构建工具: Vite 5.0

## 能力配置
- 代码生成: 全部启用
- 代码分析: 基础启用

## 约束规则
- 基础ESLint规则遵循
- 组件命名采用PascalCase

2. 企业应用模板（安全合规导向）

# AGENTS.md
## 项目元数据
- 技术栈: Angular 16, TypeScript 5.2
- 安全标准: OWASP Top 10防护

## 能力配置
- 代码生成: 启用（需安全审查）
- 代码分析: 全部启用（含安全扫描）

## 约束规则
- **安全约束**: 
  - 禁止使用dangerouslySetInnerHTML
  - API请求必须包含CSRF令牌
  - 敏感数据必须加密存储

3. 开源项目模板（贡献者导向）

# AGENTS.md
## 项目元数据
- 技术栈: Node.js 20, Express 4.18
- 贡献规范: 遵循Conventional Commits

## 能力配置
- 代码生成: 全部启用
- 文档生成: 启用API文档自动生成

## 约束规则
- 代码必须通过ESLint和Prettier检查
- PR描述需包含变更类型和影响范围