Windsurf PR 评论通过 AI 驱动的反馈帮助团队简化 GitHub Pull Request 的代码审查。此功能目前处于 Beta 阶段,适用于使用 GitHub Cloud 的团队版和企业版客户。

工作原理

启用后,Windsurf 会自动审查选定仓库中符合条件的 Pull Request,并以 GitHub 评论的形式提供反馈。

当您将 PR 标记为“准备审查”或在 PR 评论中输入 /windsurf-review 时,可以手动触发审查。

您也可以通过在 PR 标题中输入 /windsurf 来编辑 PR 标题。

示例工作流程

  1. 开发者在已启用的仓库中创建 Pull Request
  2. 开发者将 PR 标记为准备审查或在 PR 评论中输入“@windsurf /review”
  3. Windsurf 审查 PR 并以 GitHub 评论的形式发布反馈
  4. 开发者处理反馈并更新 PR
组织每月限额 500 次审查。

设置

组织管理员必须将 Windsurf GitHub 机器人连接到您的 GitHub Cloud 组织才能启用 Windsurf PR 评论

  1. 导航到 Windsurf 团队设置页面并点击 GitHub 集成,或点击此处
  2. 在 GitHub 侧安装过程中,选择要启用 PR 评论的仓库
  3. 回到 Windsurf 设置中,配置允许审查/编辑的开关,定义 PR 审查和描述的指南
  4. 组织中的所有用户随后都可以在其 Pull Request 上收到 PR 评论
草稿 Pull Request 不会触发审查。

禁用 PR 评论

要禁用 Windsurf PR 评论,请断开 Windsurf GitHub 机器人与您组织的连接,或通过 GitHub 设置将其从特定仓库中移除。

最佳实践

为了进行有效的 PR 审查

  • 在 PR 指南中使用自然语言
  • 不要对您更改的目的含糊不清
  • 在有帮助的地方包含详细示例