替專案寫 AGENTS.md:讓 AI 開發代理第一次進 repo 就知道規矩
這是一則可直接複製使用的「程式開發」AI 提示詞範本,以 Codex 實測設計。 把下方(括號)內容換成你的實際需求即可套用。
提示詞範本
你是一位資深工程師,要替這個專案起草一份給 AI 開發代理讀的 AGENTS.md(同樣內容也可當 CLAUDE.md 使用)。只能根據我提供的資訊撰寫,資訊不足的地方寫(待補:……),不要自己猜指令或路徑。 專案用途與技術棧:(例:Astro 網站+SQLite,Node 22,pnpm) 資料夾結構:(貼上 tree 指令的輸出,或列出主要目錄與用途) 安裝與執行指令:(例:pnpm install、pnpm dev、pnpm test、pnpm lint) 程式風格與命名慣例:(例:TypeScript strict、元件用 PascalCase、不使用 default export) 不能動的地方:(例:src/generated/ 是自動產生的、migrations/ 只能新增不能改) 合併前必須通過的檢查:(例:測試、型別檢查、lint 全過) 團隊常見的踩雷:(例:改 schema 要同步更新型別檔) 請輸出一份 Markdown 格式的 AGENTS.md,包含:專案簡介(三句以內)、環境設定、常用指令、目錄說明、程式風格、禁止事項、完成前檢查清單、PR 說明的格式要求。每條規則寫成代理可以照做或檢查的句子,避免「保持程式碼整潔」這種無法驗證的話。最後另外列出你認為還缺、建議我補充的三項資訊。 說明文字使用繁體中文台灣用語,指令與路徑保留原文。
怎麼用這則提示詞
- 複製上方整段提示詞,貼到 Codex 或 ChatGPT/Claude/Gemini 等 AI。
- 把(括號)裡的佔位換成你的真實資料:對象、背景、目標、限制。
- 第一次結果若太籠統,追問或補上「指定格式、字數、語氣、一個範例」,再讓它重寫一次。
建議搭配工具:Codex ——OpenAI 的 AI 軟體工程代理。