首页
/ AGENTS.md配置文件

AGENTS.md配置文件

2026-03-13 04:37:09作者:蔡丛锟

能力范围

  • 支持React和TypeScript代码自动补全
  • 提供代码优化和重构建议
  • 生成符合JSDoc规范的文档注释

约束条件

  • 禁止使用任何未在package.json中声明的依赖
  • 避免生成包含敏感信息的代码
  • 遵循项目的ESLint配置规则

### 第三步:配置项目特定规则与测试优化

根据项目特点添加定制化规则,如文件组织结构、命名规范和注释格式等。完成配置后,通过实际使用验证效果,并根据反馈持续优化。例如:

```markdown
## 项目特定规则
- 组件文件必须放在components目录下
- 函数命名使用camelCase格式
- 每个组件必须包含PropTypes或TypeScript接口定义

## 测试与优化
- 使用pages/index.tsx测试代码生成效果
- 检查生成的代码是否符合styles/globals.css中的样式规范
- 根据测试结果调整配置内容

多场景适配技巧:让AI助手适应不同开发阶段

开发阶段配置

在开发阶段,应侧重代码生成和快速迭代,配置示例:

## 开发阶段配置
- 启用实验性API建议
- 优先使用最新的React特性
- 生成代码时包含详细注释

测试阶段配置

测试阶段需要强调代码质量和错误检测,配置示例:

## 测试阶段配置
- 自动生成单元测试代码
- 检查代码中的潜在bug
- 验证代码是否符合测试覆盖率要求

生产阶段配置

生产阶段则应关注性能和安全性,配置示例:

## 生产阶段配置
- 禁用console.log等调试语句
- 优化代码以减少bundle体积
- 检查常见的安全漏洞

团队协作与进阶技巧

团队知识库集成

将AGENTS.md与团队文档系统结合,让AI助手能够参考项目历史决策和最佳实践。例如:

## 团队知识库
- 参考文档:[AGENTS.md标准详解.md](https://gitcode.com/GitHub_Trending/ag/agents.md/blob/d1ac7f063d20e70015ed6732664049ae4ba9d74e/AGENTS.md标准详解.md?utm_source=gitcode_repo_files)
- 代码示例:[components/CodeExample.tsx](https://gitcode.com/GitHub_Trending/ag/agents.md/blob/d1ac7f063d20e70015ed6732664049ae4ba9d74e/components/CodeExample.tsx?utm_source=gitcode_repo_files)
- 最佳实践:[HowToUseSection.tsx](https://gitcode.com/GitHub_Trending/ag/agents.md/blob/d1ac7f063d20e70015ed6732664049ae4ba9d74e/components/HowToUseSection.tsx?utm_source=gitcode_repo_files)

版本控制与配置共享

将AGENTS.md纳入版本控制系统,确保所有团队成员都能获取最新的配置版本。建议在README.md中添加配置说明:

# 项目配置指南
请确保你的AGENTS.md文件与主分支保持同步,以获得最佳的AI助手体验。
配置更新日志:[AGENTS.md改写prompt.md](https://gitcode.com/GitHub_Trending/ag/agents.md/blob/d1ac7f063d20e70015ed6732664049ae4ba9d74e/AGENTS.md改写prompt.md?utm_source=gitcode_repo_files)
登录后查看全文
热门项目推荐
相关项目推荐