AGENTS.md 配置文件

能力范围定义

• 代码生成：支持React组件、TypeScript类型定义、API接口封装
• 代码分析：提供性能优化建议、安全漏洞检测、重构方案
• 文档生成：自动创建API文档、组件说明、使用示例

技术栈约束

• 前端框架：React 18+，禁止使用Vue或Angular相关语法
• 状态管理：优先使用React Context + useReducer，避免Redux
• 样式方案：仅支持Tailwind CSS，不生成CSS Modules代码

[![AGENTS.md配置生态](https://raw.gitcode.com/GitHub_Trending/ag/agents.md/raw/d1ac7f063d20e70015ed6732664049ae4ba9d74e/public/og.png?utm_source=gitcode_repo_files)](https://gitcode.com/GitHub_Trending/ag/agents.md?utm_source=gitcode_repo_files)

*AGENTS.md配置生态：已被Codex、Cursor、VS Code等主流开发工具支持的开放标准*

### 2.3 验证与调试方法
✅ 已验证步骤：配置有效性测试流程
1. 在项目中创建测试文件`agent-test.tsx`
2. 触发AI代码生成功能（通常为输入`//`或使用命令面板）
3. 检查生成代码是否符合AGENTS.md中定义的技术栈约束
4. 若存在偏差，使用`# DEBUG`标签在配置文件中添加具体修正指令

## 三、进阶策略：五大场景的智能配置优化

### 3.1 开发阶段动态切换
根据项目生命周期调整AI行为：
- **开发初期**：启用"探索模式"，放宽约束以鼓励创新实现
  ```markdown
  # PHASE: development
  - 允许实验性API建议
  - 优先考虑开发速度而非性能优化

• 测试阶段：激活"质量模式"，强化代码健壮性检查

  # PHASE: testing
  - 自动生成单元测试代码
  - 强制错误处理和边界条件检查
  

思考问题：如何设计基于Git分支自动切换的AGENTS.md配置方案？提示：可结合Git hooks实现配置文件的动态替换。

3.2 技术债务管理配置

针对 legacy 项目的特殊优化：

# TECH_DEBT
- 识别并标记使用React class组件的代码
- 提供Hooks迁移建议但不自动重构
- 对已标记为"待重构"的模块生成兼容性代码

3.3 安全合规强化

金融科技项目的安全配置示例：

# SECURITY
- 禁止生成硬编码的API密钥和凭证
- 自动检测SQL注入风险并提供参数化查询方案
- 所有用户输入处理必须包含XSS防护代码

⚠️ 常见误区：将安全规则设置得过为严格会导致AI生成过度复杂的代码。建议采用"最小权限"原则，仅对高风险场景设置强制约束。

3.4 性能优化定向配置

大型应用的性能优化策略：

# PERFORMANCE
- React组件必须使用React.memo或useMemo优化重渲染
- 列表渲染必须实现虚拟滚动（超过50项时）
- API请求必须包含缓存策略和错误重试机制

3.5 团队协作增强

分布式团队的协作配置：

# COLLABORATION
- 代码必须包含详细的JSDoc注释
- 复杂逻辑需自动生成流程图说明
- 提交信息遵循Conventional Commits规范