heydeer
参考

设置参考

审查规则中的每项设置及其默认值和作用,以及 HeyDeer 其余配置的位置和限制。

前五个表格对应工作区设置 → 审查规则的各个部分。默认值是新工作区的初始值,每项设置都链接到对应的说明页面。仓库会沿用工作区的值,直到你为其自定义;参见设置如何生效。

何时审查

设置项默认值作用
审查时机仅手动HeyDeer 是否自动审查 PR:每个 PR 审查一次、每次推送时审查或仅手动。
每个 PR 的自动审查次数上限5选择每次推送时审查时,PR 的自动审查成功达到该次数后即停止。可选 1、2、3、5、10、20 或不限次数。
PR 关闭后停止自动审查已开启PR 关闭或合并时,停止其排队中和运行中的自动审查。
自动审查筛选条件PR 状态 → 不是草稿,PR 来源 → 是以下任意一项 → 同一仓库,以及作者 → 不是以下任意一项 → dependabot[bot]、renovate[bot]、pre-commit-ci[bot]、snyk-io[bot]、snyk-bot按标签、作者、团队、账号类型、草稿状态和来源,决定自动审查覆盖哪些 PR。PR 必须匹配每一行。

如何审查

设置项默认值作用
默认审查深度标准标准或深度。“深度”在每一步上花费更多时间,消耗更多积分,且需要付费套餐。
只审查新改动已开启后续审查只覆盖自上次审查以来的改动,并重新检查此前的问题。
反馈范围平衡根据确信程度和严重程度决定 HeyDeer 报告哪些问题:精简、平衡或详尽。
审查语言EnglishHeyDeer 发布到 GitHub 的所有内容(包括发现的问题、HeyDeer Review 检查和命令回复)所用的语言:English, 简体中文, 日本語, Español, 한국어, Português (Brasil), Deutsch。代码和文件路径保持不变。
读取相关 Issue 和 PR已开启允许 HeyDeer 读取同一仓库中能说明此次改动的 Issue 和 PR。
导览已开启添加变更指引:将相关改动归为一组,并突出重要的部分。
保留仓库快照已开启大型仓库从默认分支的快照开始审查,启动更快。快照会在最后一次使用一天后删除,关闭此设置时也会删除。

发布结果

设置项默认值作用
自动批准已关闭允许 HeyDeer 批准满足下面两项条件的 PR。仅在开启在 PR 中发布审查评论时生效。
可自动批准的 PR低风险和中风险 PRHeyDeer 可以自动批准的最高风险等级:低风险 PR、低风险和中风险 PR 或所有风险等级的 PR。
允许保留的问题无待处理问题仍有低严重程度的问题或此前的问题时,HeyDeer 是否可以批准:无待处理问题或允许低严重程度问题。
发布 GitHub 检查已开启在 HeyDeer Review 检查中显示审查进度和结果。
发现问题时将检查标记为失败已关闭出现发现的问题、仍未解决或尚未确认的此前问题,或审查不完整时,将检查标记为失败。仅在开启发布 GitHub 检查时适用。
在 PR 中发布审查评论已开启在 PR 上发布每次审查。关闭后,自动批准和将讨论标记为已解决的功能也会关闭。
将已处理的 HeyDeer 讨论标记为已解决已开启后续审查发现问题已修复,或接受了不处理的决定后,将 HeyDeer 的讨论标记为已解决。

Autopilot

设置项默认值作用
每次运行的最大轮数5Autopilot 运行达到此轮数后停止:3、5、8、10、12 或 15。

手动审查权限

设置项默认值作用
谁可以发起审查拥有仓库写权限的所有人谁可以在 PR 评论中或在检查上向 HeyDeer 发起审查。另一个选项拥有写权限的指定用户或团队最多可填写 100 个用户名,在组织中还可填写最多 30 个团队。

在 HeyDeer 中配置

审查使用 HeyDeer 将其加入队列时已保存的审查规则、指令和连接器。PR 无法更改它们。

配置位置谁可以更改规则与限制
审查规则“工作区设置 → 审查规则”,或“仓库 →(某个仓库)→ 审查规则”工作区管理员仓库会沿用每项工作区默认设置,直到你为其自定义。
审查指令“工作区设置 → 审查指令”,或“仓库 →(某个仓库)→ 审查指令”工作区管理员纯文本或 Markdown,每个层级最多 12,000 个字符。两者冲突时以仓库指令为准。
连接器工作区设置 → 连接器同时是 GitHub 组织或账号所有者的工作区管理员付费套餐包含连接器。每个工作区最多 50 个,每个都必须是位于公共 HTTPS 端点的 Streamable HTTP 服务器。

只有在 GitHub 上能访问某个仓库的管理员,才能更改该仓库的设置。参见工作区成员。

仓库文件

HeyDeer 还会从被审查的仓库中读取以下文件。任何可以向 PR 分支推送的人,都能更改从该分支读取的文件;参见 PR 可以更改哪些内容。

文件读取来源规则与限制
AGENTS.md, CLAUDE.mdPR 自身的版本任意目录。作用于所在目录及其子目录;层级更深的文件优先。目录中没有 AGENTS.md 时,会读取 CLAUDE.md。从根目录到某个目录总共最多读取 32 KiB;其余部分不会读取。
REVIEW.mdPR 自身的版本任意目录。作用于所在目录及其子目录中的改动;层级更深的文件优先。不读取符号链接。
.agents/checks/*.mdPR 自身的版本每个检查一个 Markdown 文件,直接放在 .agents/checks 中,且 frontmatter 含有 files。文件名以字母或数字开头,只能包含字母、数字、.、_ 和 -。每个文件最大 16,000 字节。每次审查按文件名顺序最多运行 10 个匹配的检查。
.agents/skills/PR 自身的版本在检查列出它时使用。每个技能是一个包含 SKILL.md 的文件夹,文件夹名由小写字母、数字和单个连字符组成,最多 64 个字符。
.gitattributes目标分支标记为 linguist-generated 的文件,以及该分支中已有且未标记为 -linguist-generated 的锁文件,不在审查范围内。任何可以合并到目标分支的人都能更改该文件。

检查的 frontmatter

每个检查都以两行 --- 之间的 YAML frontmatter 开头。HeyDeer 会忽略其他键。

键值作用
files一个模式或模式列表必填;缺少此键时,HeyDeer 会忽略该文件。检查覆盖的改动文件。在模式前加 ! 可排除文件;使用排除模式时,至少还要有一个包含模式。
skills一个技能名称或名称列表可选。检查使用的技能,从 PR 中加载。缺少技能不会中止审查。