AGENTS.md 起手式：minimal 與 advanced 兩種範本（給 Codex／任何 agent）

# === 範本 A：Minimal AGENTS.md（5 行就上路）===
# AGENTS.md

- 使用 {{NODE_OR_RUNTIME}}（例：Node 22 LTS）。
- 安裝相依套件：`{{INSTALL_CMD}}`（例：pnpm install）。
- 跑測試：`{{TEST_CMD}}`（例：pnpm test）。
- 格式化程式碼：`{{FORMAT_CMD}}`（例：pnpm format / Prettier）。
- 安全限制：除了 {{ALLOWED_ENDPOINT}} 之外，不得呼叫任何外部網路端點。

# === 範本 B：Advanced AGENTS.md（含 5 大區塊 + 範例任務）===
# AGENTS.md

## Overview
{{PROJECT_OVERVIEW}}（例：以 pnpm workspaces 驅動的模組化 TypeScript monorepo，採用 Airbnb + Prettier 風格）。

## Environment
- 本機開發：`{{DEV_CMD}}`（例：pnpm dev）。
- 相依基礎設施：{{INFRA}}（例：需要 Docker；`docker compose up -d` 啟動 Postgres 與 Redis）。

## Testing
- 單元測試：`{{TEST_CMD}}`。
- 整合測試：{{INTEGRATION_NOTE}}（例：需先啟動 Docker）。
- 鐵則：一個 commit 必須讓測試套件保持全綠。

## Coding Conventions
- 命名：檔名用 kebab-case；{{COMPONENT_LOCATION}}（例：React 元件放在 /src/components）。
- 風格：偏好函式式寫法，避免全域可變狀態。
- 其他：{{EXTRA_CONVENTIONS}}。

## Safety
- 禁止用使用者輸入直接拼出 shell 指令。
- 未經人類授權不得使用 `sudo` 或執行破壞性操作。
- {{EXTRA_SAFETY_RULES}}。

## Example Tasks
- 範例 1：實作 {{EXAMPLE_ENDPOINT}} 端點，並補上單元測試。
- 範例 2：重構 {{EXAMPLE_SERVICE}} 服務，行為不變、測試保持綠燈。

# === 使用說明 ===
# 新專案先用範本 A 起步；當需要規範環境、測試、慣例與安全邊界時，升級到範本 B。
# 把 AGENTS.md 放在 repo 根目錄；多數 agent（含 OpenAI Codex）會自動讀取它。

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

# === 範本 A：Minimal AGENTS.md（5 行就上路）===
# AGENTS.md

- 使用 {{NODE_OR_RUNTIME}}（例：Node 22 LTS）。
- 安裝相依套件：`{{INSTALL_CMD}}`（例：pnpm install）。
- 跑測試：`{{TEST_CMD}}`（例：pnpm test）。
- 格式化程式碼：`{{FORMAT_CMD}}`（例：pnpm format / Prettier）。
- 安全限制：除了 {{ALLOWED_ENDPOINT}} 之外，不得呼叫任何外部網路端點。

# === 範本 B：Advanced AGENTS.md（含 5 大區塊 + 範例任務）===
# AGENTS.md

## Overview
{{PROJECT_OVERVIEW}}（例：以 pnpm workspaces 驅動的模組化 TypeScript monorepo，採用 Airbnb + Prettier 風格）。

## Environment
- 本機開發：`{{DEV_CMD}}`（例：pnpm dev）。
- 相依基礎設施：{{INFRA}}（例：需要 Docker；`docker compose up -d` 啟動 Postgres 與 Redis）。

## Testing
- 單元測試：`{{TEST_CMD}}`。
- 整合測試：{{INTEGRATION_NOTE}}（例：需先啟動 Docker）。
- 鐵則：一個 commit 必須讓測試套件保持全綠。

## Coding Conventions
- 命名：檔名用 kebab-case；{{COMPONENT_LOCATION}}（例：React 元件放在 /src/components）。
- 風格：偏好函式式寫法，避免全域可變狀態。
- 其他：{{EXTRA_CONVENTIONS}}。

## Safety
- 禁止用使用者輸入直接拼出 shell 指令。
- 未經人類授權不得使用 `sudo` 或執行破壞性操作。
- {{EXTRA_SAFETY_RULES}}。

## Example Tasks
- 範例 1：實作 {{EXAMPLE_ENDPOINT}} 端點，並補上單元測試。
- 範例 2：重構 {{EXAMPLE_SERVICE}} 服務，行為不變、測試保持綠燈。

# === 使用說明 ===
# 新專案先用範本 A 起步；當需要規範環境、測試、慣例與安全邊界時，升級到範本 B。
# 把 AGENTS.md 放在 repo 根目錄；多數 agent（含 OpenAI Codex）會自動讀取它。