3-6 透過 Cursor 協助生成 PR 描述
2025年4月19日
在上一個單元中，我們與大家分享了如何透過 Cursor 來協助生成程式碼的 commit 訊息，讓整個程式碼庫能有更好的可維護性。
在這個單元中，我們將進一步探討，當你完成了多個 commit，在整個軟體開發的生命週期中，下一步要做的事情就是發 pull request (PR)，讓其他開發者進行 code review。
我們先前曾在 E+ 中寫過 為團隊建立更好的 Code Review 原則與規範 主題文。提到如果希望團隊中的其他開發者在進行 Code Review 時，能更輕鬆地看別人的程式碼，進而降低大家的時間成本，一個好的 PR 描述是非常重要的。
在那篇主題文中我們談到，一個高品質的 PR 描述，除了談為什麼 (why)、有什麼改動 (what) 外， 也要包含例如測試規劃 (testing plan)；如果是前端或行動端相關的改動，則建議附上螢幕截圖或錄影。
此外，我們也分享了一些值得參考的 PR 範例。如果你暫停影片，稍微溫習一下這篇文章後，接下來我們會進一步討論如何透過 Cursor 快速撰寫出高品質的 PR 描述。
以下是推薦的模板
## 背景描述 (Why)
<!-- 描述此 PR 的背景，為什麼需要這個 PR? 它解決了什麼問題? -->
## 實作方法 (How)
<!-- 描述實作方法和所做的架構決策。 -->
## 實際變更（做了什麼）
<!-- 強調此合併請求中實作的主要變更。具體說明您更改了什麼以及為什麼。 -->
- [ ] 功能/變更 1
- [ ] 功能/變更 2
### 截圖或錄影參考
<!-- 如適用，添加設計參考（連結）、截圖或螢幕錄製 -->
### 測試驗證
<!-- 列出已驗證的測試案例。包括極端案例。 -->
- [ ] 測試場景 1
- [ ] 測試場景 2
- [ ] 測試場景 3
<!-- 為審核者添加任何其他測試註釋 -->
## 補充說明
<!-- 任何對 PR 審核者有幫助的資訊（例如：已知限制、未來待辦事項） -->
## 相關連結
<!-- 跟 PR 相關的連結 -->
當按照這樣的模板撰寫 PR 描述時，其他負責 Code Review 的開發者就能在開始時快速了解 PR 的概要，後續的審查過程也會變得更輕鬆簡單。不僅如此，這樣 PR 描述不僅在當下的 code review 有幫助，對於未來新加入的開發者來說也很有價值。如果未來的維護者想了解某個功能的歷史脈絡，查閱相關 PR 時，一個完整的 PR 描述能讓人更容易掌握開發背景，對程式碼的維護或新成員的融入都很有幫助。
然而，若按照這樣的模板手動撰寫，包括背景描述、實作方法、實際變更、測試案例與補充說明等，一個高品質的 PR 描述至少需要花費十分鐘。但有了 Cursor 後，這個過程可以變得非常簡單。
如何用 Cursor 加速 PR 描述的撰寫
首先，在 Cursor 中打開聊天室窗口。特別提醒，這裡建議使用 Command + L 開啟 AI 聊天室，而不是 Command + I 的 AI 代理。因為 Command + I 的 AI 代理會實際修改檔案，而我們今天的目標只是讓 Cursor 幫我們生成 PR 描述，然後一鍵複製貼到像是 GitHub 上，因此推薦使用 Command + L 的聊天方式。
開啟聊天室後，下一步很簡單。還記得前面的單元提到，我們可以透過 @ 快捷鍵，索引 Git 相關記錄作為脈絡提供給 Cursor。此時，使用 @Git 後，會出現幾個選項，包含 PR Diff with Main Branch 會顯示目前所有改動與主分支的差異，以及包含特定 commit，讓人可以選擇某個 commit 來撰寫 PR。
假設你想為兩個 commit 撰寫 PR 描述，可以搭配「PR Generation」提示詞，直接輸入「使用 PR Generation 提示詞為這兩個 commit 撰寫描述」，然後送出。
Cursor 會自動抓取這兩個 commit 的改動內容，並根據模板生成一個完整的 PR 描述。過去手動撰寫可能需要十分鐘的內容，現在不到一分鐘就能完成。Cursor 會根據程式碼改動推測 PR 的目的、實作方式、具體變更，並補充測試與驗證資訊。
因此，我們非常推薦大家用這種方式。這樣不僅能提升程式碼的可維護性，讓 code review 更輕鬆，還能讓未來維護程式碼的人在查閱歷史 PR 時一目了然。
此系列文章為 《給工程師的 Cursor 工作流 — 透過 AI 代理全方位提升開發生產力》 搭配的教材。希望透過這系列文章，將過去協助導入 AI 工具及使用 Cursor 的經驗擴展並分享給想提升生產力的讀者。如果對課程感興趣的讀者，可以加入 E+ 成長計畫，觀看影片學習。