AGENTS.md 標準起手式：一份能讓任何 AI agent 看懂的最小範本

# AGENTS.md

> 給 AI coding agent（Codex / Claude Code 等）讀的專案指引。目標：讓 agent 不靠猜就知道「平常怎麼開發、怎麼驗證、有哪些指令」。

## Dev environment（最重要的一條）
- Always use `{{DEV_CMD}}` while iterating (e.g. `npm run dev` / `pnpm dev`).
- Do NOT run production builds during agent sessions — they disable hot reload and slow iteration down.
- When in doubt, restart the dev server rather than running a production build.

## Dependencies
- After adding or updating packages, sync the lockfile and restart the dev server so the framework picks up the change.

## Code style
- Prefer {{LANGUAGE}} for new components (e.g. TypeScript).
- Co-locate styles with their component when practical.
- {{EXTRA_STYLE_RULES}}（其他你想讓 agent 遵守的風格規則，沒有可刪）

## Commands
| 目的 | 指令 |
| --- | --- |
| 開發（agent 平常用這個） | `{{DEV_CMD}}` |
| Lint | `{{LINT_CMD}}` |
| 測試 | `{{TEST_CMD}}` |
| 正式打包（agent session 外才用） | `{{BUILD_CMD}}` |

## Notes for the agent
- {{PROJECT_SPECIFIC_NOTE}}（任何專案專屬的注意事項，例：環境變數放哪、哪些目錄別動）

把方括號 [ ] 內的變數換成你的內容，丟進 OpenAI Codex。

# AGENTS.md

> 給 AI coding agent（Codex / Claude Code 等）讀的專案指引。目標：讓 agent 不靠猜就知道「平常怎麼開發、怎麼驗證、有哪些指令」。

## Dev environment（最重要的一條）
- Always use `{{DEV_CMD}}` while iterating (e.g. `npm run dev` / `pnpm dev`).
- Do NOT run production builds during agent sessions — they disable hot reload and slow iteration down.
- When in doubt, restart the dev server rather than running a production build.

## Dependencies
- After adding or updating packages, sync the lockfile and restart the dev server so the framework picks up the change.

## Code style
- Prefer {{LANGUAGE}} for new components (e.g. TypeScript).
- Co-locate styles with their component when practical.
- {{EXTRA_STYLE_RULES}}（其他你想讓 agent 遵守的風格規則，沒有可刪）

## Commands
| 目的 | 指令 |
| --- | --- |
| 開發（agent 平常用這個） | `{{DEV_CMD}}` |
| Lint | `{{LINT_CMD}}` |
| 測試 | `{{TEST_CMD}}` |
| 正式打包（agent session 外才用） | `{{BUILD_CMD}}` |

## Notes for the agent
- {{PROJECT_SPECIFIC_NOTE}}（任何專案專屬的注意事項，例：環境變數放哪、哪些目錄別動）