25-AGENTS.md最佳实践
25 · AGENTS.md 最佳实践概述前面三篇文章详细介绍了 AGENTS.md 的机制、高级用法和配置灵活性。这一篇,我们将回归到最本质的问题:怎样写出能让 AI 真正高效工作的 AGENTS.md?本文不是理论的堆砌,而是从真实踩坑经验中提炼出来的实战规则。这些规则来自大量 AGENTS.md 的编写、调试和迭代过程——既有成功的经验,也有痛苦的教训。核心原则:写给 AI 看,不是写给人看AGENTS.md 最常见的错误是把它写成一份面向人类的"团队文化手册"。但实际上,AGENTS.md 的唯一读者是 AI 编程助手。这意味着你需要调整写作方式:面向 AI 的写作原则:指令要精确:AI 喜欢精确、无歧义的陈述。不要说"代码要写好",要说"所有函数必须有类型注解,返回类型必须显式声明"。避免修辞和情感:不需要"我们坚信代码质量是团队的基石"这样的空洞表述。直接说"测试覆盖率必须 ≥ 80%"。使用列表和层级结构:Markdown 的列表(-或1.)和标题(##、###)对 AI 解析特别友好。AI 相比段落文本更能准确解析结构化内容。命令式语气:使用祈使句(“必须”、“应该”、“禁止”)而不是描述句(“我们倾向于…”)。哪些内容该写1. Codex 反复踩过的坑这是 AGENTS.md 最高价值的内容之一。当你或你的团队在使用 Codex 开发时,如果发现 AI 反复在同一个问题上犯错,就把这个教训记录下来。示例:## 常见陷阱(重要) - **不要使用已废弃的 API**:本项目曾多次踩坑 axios 旧版 API。 请使用 axios@1.x 的 API 格式,不要使用 .then() 链式调用。 - **数据库迁移必须用 Prisma**:禁止直接修改数据库表结构。 所有 schema 变更必须通过 `prisma migrate dev` 生成迁移文件。 - **时区处理**:后端所有时间存储为 UTC,前端展示时转换为用户时区。 AI 曾多次在时区转换中引入 bug。这种"踩坑记录"对 AI 特别有效,因为它直接告诉 AI"这个坑我们之前踩过了,你别再踩"。2. 项目特定约束AI 不自动知道项目的特殊约定。如果你不告诉它,它可能会按照自己的"最佳实践"生成与项目完全不符的代码。示例:## 项目特定约束 - 本项目使用 pnpm(不是 npm/yarn),安装依赖使用 `pnpm add` - 不要安装新的依赖包,除非在 Issue 中讨论过 - 项目中所有 React 组件使用 `function` 声明,禁止使用 `const Component = () = {}` - API 路由使用 `/api/v1/` 前缀 - 错误处理使用统一的 `AppError` 类,禁止直接 `throw new Error()`3. 构

相关新闻

RAG 检索优化实战:基于 Recall@5、Precision@3、NDCG@10 的 3 步调优法

RAG 检索优化实战:基于 Recall@5、Precision@3、NDCG@10 的 3 步调优法

RAG 检索优化实战:基于 Recall5、Precision3、NDCG10 的 3 步调优法在构建检索增强生成(RAG)系统时,检索模块的性能直接影响最终生成内容的质量。本文将介绍一套基于 Recall5、Precision3 和 NDCG10 指标的实用调优方法&#xff0…

2026/7/6 8:43:54 阅读更多 →
终极指南:如何使用Scarab模组管理器快速安装空洞骑士游戏模组

终极指南:如何使用Scarab模组管理器快速安装空洞骑士游戏模组

终极指南:如何使用Scarab模组管理器快速安装空洞骑士游戏模组 【免费下载链接】Scarab An installer for Hollow Knight mods written with Avalonia. 项目地址: https://gitcode.com/gh_mirrors/sc/Scarab 你是否曾经为了在《空洞骑士》中安装一个心仪的模组…

2026/7/6 8:43:54 阅读更多 →
终极智能BP助手:如何用Seraphine轻松实现英雄联盟自动BP与战绩分析

终极智能BP助手:如何用Seraphine轻松实现英雄联盟自动BP与战绩分析

终极智能BP助手:如何用Seraphine轻松实现英雄联盟自动BP与战绩分析 【免费下载链接】Seraphine 英雄联盟战绩查询工具 项目地址: https://gitcode.com/gh_mirrors/se/Seraphine 你是否在英雄联盟排位赛中经常因为错过接受对局而懊恼?是否在BP阶段…

2026/7/6 8:41:53 阅读更多 →

最新新闻

文件上传漏洞攻防实战:从原理到CISP-PTE考点全解析

文件上传漏洞攻防实战:从原理到CISP-PTE考点全解析

1. 项目概述:从一次文件上传漏洞的实战复盘说起最近在复盘CISP-PTE认证的备考过程,发现文件上传这个考点几乎是每次渗透测试的“必考题”,也是很多安全从业者从理论走向实战的第一个突破口。很多人觉得文件上传漏洞不就是传个木马吗&#xff…

2026/7/6 9:34:39 阅读更多 →
AppScan 扫描结果分析:5步法高效验证与处理100+个潜在漏洞

AppScan 扫描结果分析:5步法高效验证与处理100+个潜在漏洞

AppScan扫描结果深度解析:从漏洞验证到修复落地的全流程指南当安全扫描工具弹出"发现100潜在漏洞"的警示时,开发团队的第一反应往往是头皮发麻。我曾见证过某金融项目团队面对AppScan生成的287页报告时的崩溃场景——安全工程师通宵标记出的&q…

2026/7/6 9:32:36 阅读更多 →
从OWASP指南到安全代码模板:Semgrep与Cookiecutter实战

从OWASP指南到安全代码模板:Semgrep与Cookiecutter实战

1. 项目概述:为什么我们需要“安全代码模板”?在应用安全领域,我们常常面临一个尴尬的境地:安全规范文档浩如烟海,但开发者在编码时,却很难快速、准确地找到并应用那些最关键的安全防护措施。OWASP Cheat S…

2026/7/6 9:32:36 阅读更多 →
半导体材料参数 3 大误区:禁带宽度仅决定耐温?迁移率只影响速度?

半导体材料参数 3 大误区:禁带宽度仅决定耐温?迁移率只影响速度?

半导体材料参数 3 大误区:禁带宽度仅决定耐温?迁移率只影响速度?在半导体器件设计与选型过程中,工程师们常常陷入对关键参数的片面理解。禁带宽度、载流子迁移率等基础参数的真实工程意义,远比教科书上的定义复杂得多。…

2026/7/6 9:30:31 阅读更多 →
MATLAB环境下可直接运行的人脸识别CNN工程:含完整训练测试代码、预训练模型与实操录像

MATLAB环境下可直接运行的人脸识别CNN工程:含完整训练测试代码、预训练模型与实操录像

本文还有配套的精品资源,点击获取 简介:一套开箱即用的MATLAB人脸识别CNN实现方案,适配MATLAB 2022a版本,无需额外配置即可运行。包含从数据预处理(图像缩放、归一化)、网络构建(卷积层、池化…

2026/7/6 9:28:30 阅读更多 →
JMeter CSV结果文件转HTML性能报告:命令行生成与深度解读指南

JMeter CSV结果文件转HTML性能报告:命令行生成与深度解读指南

1. 项目概述:从CSV结果到可视化洞察做性能测试,跑完脚本、拿到一堆数据只是第一步。真正考验人的,是能从这些冰冷的数据里看出门道,讲出故事。JMeter的“查看结果树”保存的CSV文件,就像一本记录了所有测试细节的原始账…

2026/7/6 9:28:30 阅读更多 →

日新闻

H2 与 MySQL 单元测试兼容性:5 个关键 SQL 语句差异与规避方案

H2 与 MySQL 单元测试兼容性:5 个关键 SQL 语句差异与规避方案

H2与MySQL单元测试兼容性:5个关键SQL语句差异与规避方案1. 单元测试中的数据库兼容性挑战在Java开发领域,单元测试是保证代码质量的重要环节。当应用涉及数据库操作时,测试环境的搭建往往成为开发者的痛点。H2数据库因其轻量级、内存模式和快…

2026/7/6 0:01:17 阅读更多 →
Windows任务栏终极清理指南:用RBTray一键隐藏窗口到系统托盘

Windows任务栏终极清理指南:用RBTray一键隐藏窗口到系统托盘

Windows任务栏终极清理指南:用RBTray一键隐藏窗口到系统托盘 【免费下载链接】rbtray A fork of RBTray from http://sourceforge.net/p/rbtray/code/. 项目地址: https://gitcode.com/gh_mirrors/rb/rbtray 你是否厌倦了Windows任务栏上密密麻麻的图标&…

2026/7/6 0:01:17 阅读更多 →
Visual C++ 运行时库一键安装终极指南:告别DLL缺失烦恼

Visual C++ 运行时库一键安装终极指南:告别DLL缺失烦恼

Visual C 运行时库一键安装终极指南:告别DLL缺失烦恼 【免费下载链接】vcredist AIO Repack for latest Microsoft Visual C Redistributable Runtimes 项目地址: https://gitcode.com/gh_mirrors/vc/vcredist 你是否曾经遇到过这样的情况:下载了…

2026/7/6 0:05:19 阅读更多 →

周新闻

B站视频下载神器BiliTools:5分钟学会轻松保存任何B站内容

B站视频下载神器BiliTools:5分钟学会轻松保存任何B站内容

B站视频下载神器BiliTools:5分钟学会轻松保存任何B站内容 【免费下载链接】BiliTools A cross-platform bilibili toolbox. 跨平台哔哩哔哩工具箱,支持下载视频、番剧等等各类资源 项目地址: https://gitcode.com/GitHub_Trending/bilit/BiliTools …

2026/7/6 8:11:50 阅读更多 →
威胁模型全解析:从新手入门到实战应用,助你构建安全产品!

威胁模型全解析:从新手入门到实战应用,助你构建安全产品!

威胁模型的陌生现状在忙碌疲惫的一天里,参与了关于混合后量子密码学的讨论,应付端点攻击找茬的人,还参与留言板讨论后,发现“威胁模型”对多数人仍是陌生概念,且多被当作时髦用语。有趣的相关画作有一幅由 Embyr 创作的…

2026/7/6 8:11:52 阅读更多 →
渗透测试入门指南:从零基础到实战环境搭建

渗透测试入门指南:从零基础到实战环境搭建

1. 从“看热闹”到“入门”:我理解的渗透测试到底是什么?每次看到新闻里说某个大公司的数据被“黑”了,或者某个网站被攻击导致服务瘫痪,你是不是和我一样,心里会冒出两个念头:一是“这黑客真厉害”&#x…

2026/7/6 6:52:56 阅读更多 →

月新闻