用途
setup-bugbot 用于为当前仓库建立 Cursor Bugbot 的 PR 审查配置:包括共享的审查基础、与用户确认过的仓库专属内容,以及 bugbot.yaml 设置,最终以 PR 形式提交。
主要能力
该技能会写入仓库的 Bugbot 配置:
.cursor/BUGBOT.md:在一个标记块内放置共享基础内容(严重程度、失败示例、问题发现格式、摘要形态),其后是仅本仓库知晓的 “This repo” 部分。- 针对拥有自身不变量的目录,生成嵌套的
<dir>/.cursor/BUGBOT.md;只有当 PR 触及该目录下文件时,Bugbot 才会读取它。 .cursor/config/bugbot.yaml:控制 Bugbot 何时审查以及审查力度。
共享基础只保存在 bugbot-base.md 一处。重跑该技能时,会从该文件刷新标记块内容,并保留 “This repo” 部分不变;因此更新所有仓库的流程是:修改模板、在此处重跑、提交 PR。
使用方式
整体流程为:探索、起草、与用户确认、写入。
- 准备:要求工作区干净,从默认分支切出 setup-bugbot 分支。
- 探索与起草:先阅读仓库再做询问。信息来源包括现有的
.cursor/BUGBOT.md、嵌套的.cursor/BUGBOT.md、.cursor/config/bugbot.yaml,AGENTS.md、CLAUDE.md、GLOSSARY.md、ADR、docs/agents/,schema、迁移以及负责金钱、鉴权、权限或持久化状态的模块,测试运行器及其单文件调用方式(package.json scripts、pyproject.toml、Makefile)和 CI 工作流,以及gh pr list --state merged --limit 20及这些 PR 的审查评论(反复出现的缺陷即为待写入的不变量)。 起草 “This repo” 部分,逐项包括:不变量(diff 可能静默破坏的规则,如“金额使用整数分”“事件为追加写入”,并注明来源文件或文档)、热路径(should-fix 即视为阻断的目录,如鉴权、计费、迁移)、忽略项(生成、第三方引入和夹具路径)、验证命令(如何运行单个测试文件,路径用占位符)、规格来源(关联 issue 所在位置)。仅涉及单个目录的不变量标记到该目录的嵌套文件,根部分保留仓库级内容。 - 确认:以提问形式进行一轮确认,编号问题并附建议。包括逐项展示起草的 “This repo” 部分及其证据;提议的每个嵌套文件(目录与内容);对无标记的现有 BUGBOT.md 展示并提议哪些规则移入 “This repo”,其余因基础已覆盖而丢弃;以及每个 bugbot.yaml 设置(推荐值优先,并列出常见备选):triggers.frequency 推荐 everyPush(备选 oncePerPr,更便宜但会遗漏后续提交中的缺陷)、triggers.drafts 推荐 false(备选 true,也审查草稿但用量更多)、review.effort 推荐 default(备选 low 更便宜更浅、high 更深更贵、smart 由 Bugbot 按 PR 选择)、review.incremental 推荐 true(备选 false,每次推送重新审查整个 PR)、prSummary.mode 推荐 comment(备选 description 写入 PR 正文、disabled)、prSummary.riskScore 推荐 true(备选 false)、autofix.mode 推荐 disabled(备选 newBranch 在侧分支修复、existingBranch 将修复推送到 PR 分支)。等待回答后再写入。
- 写入:根
.cursor/BUGBOT.md的结构为标题# Bugbot review rules,标记块<!-- bugbot-base:begin -->与<!-- bugbot-base:end -->之间原样放入 bugbot-base.md 内容,其后为## This repo,含### Invariants、### Hot paths、### Ignore、### Verify command、### Spec source。标记已存在时只替换标记之间内容。每个确认的嵌套文件写为<dir>/.cursor/BUGBOT.md,仅包含该目录的不变量,置于## This folder下。写入.cursor/config/bugbot.yaml(version: 1,triggers.drafts、triggers.frequency、review.effort、review.incremental、prSummary.mode、prSummary.riskScore、autofix.mode 使用确认值)。Bugbot 从基础分支读取 bugbot.yaml,因此设置在该 PR 合并后生效。 - 提交 PR:提交后运行
/open-pr。最后告知用户只有他们能完成的步骤:在 cursor.com/automations/from-cursor/bugbot 确认该仓库已启用;在 GitHub 上,Bugbot 覆盖 Cursor GitHub 应用可访问的仓库,若缺少该仓库需授予应用访问权限。可选门禁:若其套餐提供 fail-on-unresolved,可开启并设置 Cursor Bugbot 检查为必需,从而阻断合并;它会对任何未解决问题(包括 nit)失败,因此解决 nit 成为合并流程的一部分。
适用场景
适用于需要为仓库配置 Cursor Bugbot PR 审查的团队,尤其是希望多个仓库共享同一套审查基础、同时保留各仓库专属规则的场景。
限制
需要干净的工作区,并要求能够创建分支和 PR;配置中各项取值范围和具体行为以资料所述为准;fail-on-unresolved 是否可用取决于用户套餐,资料未说明具体套餐与价格。