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+ 成长计划，观看影片学习。