跳轉到主要內容
自訂指令能讓你建立可重複使用的工作流程,並可在聊天輸入框中用簡單的「/」前綴觸發。這些指令有助於在團隊內標準化流程,並讓常見任務更有效率。
Commands input example
指令目前為測試版。隨著我們持續改進,功能與語法可能會有所變動。

指令如何運作

指令是以純 Markdown 檔案定義,並可存放在兩個位置:
  1. 專案指令:存放在專案的 .cursor/commands 目錄
  2. 全域指令:存放在使用者家目錄的 ~/.cursor/commands 目錄
當你在聊天輸入框輸入 / 時,Cursor 會自動偵測並顯示這兩個目錄中的可用指令,讓你在工作流程中立即存取。

建立指令

  1. 在專案根目錄建立 .cursor/commands 資料夾
  2. 新增具描述性的 .md 檔名(例如:review-code.mdwrite-tests.md
  3. 用純 Markdown 撰寫內容,描述這個指令要做什麼
  4. 當你輸入 / 時,指令會自動出現在聊天中
以下是指令資料夾的範例結構:
.cursor/
└── commands/
    ├── 回應-github-pr-評論.md
    ├── 程式碼審查清單.md
    ├── 建立-pr.md
    ├── 輕量檢視-現有差異.md
    ├── 新進開發者-入門.md
    ├── 執行所有測試並修正.md
    ├── 資安稽核.md
    └── 設定新功能.md

範例

在你的專案中試試這些指令,體驗它們的運作方式。
# 程式碼審查清單

## 概述
用於進行詳盡程式碼審查的完整清單,確保品質、安全與可維護性。

## 審查類別

### 功能
- [ ] 程式碼能達成預期行為
- [ ] 已涵蓋邊界案例
- [ ] 錯誤處理恰當
- [ ] 無明顯錯誤或邏輯問題

### 程式碼品質
- [ ] 程式碼可讀且結構良好
- [ ] 函式精簡且聚焦
- [ ] 變數名稱清楚具描述性
- [ ] 無重複程式碼
- [ ] 遵循專案慣例

### 安全性
- [ ] 無明顯安全性弱點
- [ ] 具備輸入驗證
- [ ] 妥善處理敏感資料
- [ ] 無硬編碼的機密
# 安全稽核

## 概述
全面性的安全審查,用於識別並修補程式碼庫中的弱點。

## 步驟
1. **相依套件稽核**
   - 檢查已知漏洞
   - 更新過時套件
   - 檢閱第三方相依

2. **程式碼安全審查**
   - 檢查常見漏洞
   - 檢閱身分驗證/存取授權
   - 稽核資料處理做法

3. **基礎設施安全**
   - 檢閱環境變數
   - 檢查存取控制
   - 稽核網路安全

## 安全檢查清單
- [ ] 相依套件已更新且安全
- [ ] 無硬編碼密鑰/秘密
- [ ] 已實作輸入驗證
- [ ] 身分驗證安全
- [ ] 存取授權設定正確
# 設定新功能

## 概述
從初始規劃到實作架構,系統化地設定一個新功能。

## 步驟
1. **定義需求**
   - 釐清功能範圍與目標
   - 撰寫使用者故事與驗收標準
   - 規劃技術方案

2. **建立功能分支**
   - 從 main/develop 分支出來
   - 設定本機開發環境
   - 設定任何新的相依項

3. **規劃架構**
   - 設計資料模型與 API
   - 規劃 UI 元件與流程
   - 規劃測試策略

## 功能設定檢查清單
- [ ] 需求已完成文件化
- [ ] 使用者故事已撰寫
- [ ] 技術方案已規劃
- [ ] 功能分支已建立
- [ ] 開發環境已就緒
# 建立 PR

## 概述
建立一個結構完善的 Pull Request,包含清楚的說明、標籤與審查者。

## 步驟
1. **準備分支**
   - 確保所有變更都已提交
   - 將分支推送到遠端
   - 確認分支已與 main 保持最新

2. **撰寫 PR 說明**
   - 清楚摘要變更內容
   - 說明背景與動機
   - 列出任何破壞性變更
   - 若有 UI 變更請附上截圖

3. **設定 PR**
   - 以具描述性的標題建立 PR
   - 加上合適的標籤
   - 指派審查者
   - 連結相關議題

## PR 範本
- [ ] 功能 A
- [ ] 錯誤修正 B
- [ ] 單元測試通過
- [ ] 手動測試完成
# 執行所有測試並修正失敗

## 概觀
執行完整測試套件並有系統地修正任何失敗,確保程式碼品質與功能正確。

## 步驟
1. **執行測試套件**
   - 執行專案中的所有測試
   - 擷取輸出並找出失敗項目
   - 同時檢查單元測試與整合測試

2. **分析失敗**
   - 依類型分類:不穩定、故障、全新失敗
   - 依影響程度排定修復優先級
   - 檢查失敗是否與近期變更相關

3. **系統性修正問題**
   - 先處理最嚴重的失敗
   - 一次修正一個問題
   - 每次修正後重新執行測試
# 新開發者入門

## 概述
完整的入門流程,幫新開發者快速上手。

## 步驟
1. **環境設定**
   - 安裝必要工具
   - 設定開發環境
   - 設定 IDE 與擴充套件
   - 設定 Git 與 SSH 金鑰

2. **熟悉專案**
   - 檢視專案結構
   - 理解系統架構
   - 閱讀關鍵文件
   - 設定本機資料庫

## 入門檢查清單
- [ ] 開發環境就緒
- [ ] 所有測試皆通過
- [ ] 能在本機執行應用程式
- [ ] 資料庫已設定並可正常運作
- [ ] 已提交第一個 PR
I