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)
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5-w4a8GLM-5-w4a8基于混合专家架构,专为复杂系统工程与长周期智能体任务设计。支持单/多节点部署,适配Atlas 800T A3,采用w4a8量化技术,结合vLLM推理优化,高效平衡性能与精度,助力智能应用开发Jinja00
jiuwenclawJiuwenClaw 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。Python0209- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
AtomGit城市坐标计划AtomGit 城市坐标计划开启!让开源有坐标,让城市有星火。致力于与城市合伙人共同构建并长期运营一个健康、活跃的本地开发者生态。01
MarkFlowy一款 AI Markdown 编辑器TSX01
热门内容推荐
最新内容推荐
项目优选
收起
deepin linux kernel
C
27
12
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
617
4.08 K
Ascend Extension for PyTorch
Python
453
538
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
69
21
暂无简介
Dart
858
205
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
926
775
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.48 K
836
AscendNPU-IR是基于MLIR(Multi-Level Intermediate Representation)构建的,面向昇腾亲和算子编译时使用的中间表示,提供昇腾完备表达能力,通过编译优化提升昇腾AI处理器计算效率,支持通过生态框架使能昇腾AI处理器与深度调优
C++
114
178
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
374
254
昇腾LLM分布式训练框架
Python
133
159