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)
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0138- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
MiniCPM-V-4.6这是 MiniCPM-V 系列有史以来效率与性能平衡最佳的模型。它以仅 1.3B 的参数规模,实现了性能与效率的双重突破,在全球同尺寸模型中登顶,全面超越了阿里 Qwen3.5-0.8B 与谷歌 Gemma4-E2B-it。Jinja00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00
MusicFreeDesktop插件化、定制化、无广告的免费音乐播放器TypeScript00
热门内容推荐
最新内容推荐
项目优选
收起
暂无描述
Dockerfile
726
4.66 K
Ascend Extension for PyTorch
Python
597
750
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.09 K
610
deepin linux kernel
C
29
16
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
997
138
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
427
377
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
992
986
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.65 K
970
暂无简介
Dart
969
246
昇腾LLM分布式训练框架
Python
161
190