重點 #3 · 核心武器

CLAUDE.md

把專案規則永久寫進去,不要每次都重講一次。

# 團隊知識

📐 專案架構
✨ Coding style
🧪 Lint / test 規則
📋 PR 規範
🚫 禁止事項
📜

CLAUDE.md

永久

# AI 啟動 = 自動載入

🤖

✓ 已知道規則

沒有 vs 有 CLAUDE.md

❌ 沒有

每次都要重講

$ 我們用 pnpm 不用 npm

$ commit 訊息要 conventional

$ src/legacy 不要動

$ 測試要跑 vitest 不是 jest

... 然後下一輪 /clear 又要重講

✅ 有

啟動就自動知道

# CLAUDE.md

- Package manager: pnpm

- Commit: conventional

- Off-limits: src/legacy/

- Test: vitest

→ 每次啟動 = 自動套用

CLAUDE.md 內容建議

📐 專案架構
✨ Coding style
🔧 常用 command
🧪 Lint / test 規則
📋 PR 規範
🚫 禁止事項

📂 範例:一個小型 Nuxt 3 電商專案的 CLAUDE.md

~/my-shop / CLAUDE.md

# 專案架構

- Nuxt 3 + Pinia + Tailwind

- API: /server/api/ · UI: /pages//components/

...

# Coding Style

- Composition API + <script setup>,禁止 Options API

- 元件用 PascalCase,composable 用 useXxx()

...

# 常用指令

- pnpm dev · pnpm test · pnpm lint

- ⚠️ 不要用 npm / yarn,pnpm only

...

# Lint / Test 規則

- 提交前一定要過 vitest + eslint

- 新增 API 必須有對應 test

...

# PR 規範

- Conventional Commits:feat: / fix: / chore:

- 一個 PR < 300 行,超過要拆

...

# 🚫 禁止事項

- 不要動 src/legacy/ 底下任何檔案

- 不要直接改 .env、不要把 token hardcode

...

💡 每個專案的 CLAUDE.md 只要寫「你最常需要重講的事」就夠了,不必塞滿

# 一句話心法