参考
设置参考
所有审查设置及其可选值和默认值。在“组织设置 → 审查规则”中设置组织默认值;仓库可以在“仓库 →(某个仓库)→ 审查规则”中覆盖其中任何一项。参见设置如何生效。
何时审查
| 设置项 | 值 | 默认 |
|---|---|---|
| 审查时机 | 每个 PR 审查一次、每次推送时审查、仅手动 | 新工作区为“仅手动” |
| 每个 PR 的自动审查次数上限 | 1、2、3、5、10、20、不限次数。仅在“每次推送时审查”时适用。 | 5 |
| PR 关闭后停止自动审查 | 开启、关闭 | 已开启 |
| 自动审查筛选条件 | 基于 PR 标签、作者、作者所属团队、作者与组织的关系、作者账号类型、PR 状态和 PR 来源的条件。PR 必须全部满足。 | PR 状态为“不是草稿”,且 PR 来源为“同一仓库” |
如何审查
| 设置项 | 值 | 默认 |
|---|---|---|
| 默认审查深度 | 标准、深度 | 标准 |
| 只审查新改动 | 开启、关闭 | 已开启 |
| 反馈范围 | 精简、平衡、详尽 | 平衡 |
| 审查语言 | English, 简体中文, 日本語, Español, 한국어, Português (Brasil), Deutsch | English |
| 读取关联 Issue | 开启、关闭 | 已开启 |
发布结果
| 设置项 | 值 | 默认 |
|---|---|---|
| 自动批准 | 不自动批准、仅简单改动、没有发现任何问题时 | 不自动批准 |
| 发布 GitHub 检查 | 开启、关闭 | 已开启 |
| 发现问题时将检查标记为失败 | 开启、关闭。仅在“发布 GitHub 检查”开启时适用。 | 已关闭 |
| 在 PR 中发布审查评论 | 开启、关闭。关闭后,自动批准和将讨论标记为已解决的功能也会关闭。 | 已开启 |
| 将已处理的 HeyDeer 讨论标记为已解决 | 开启、关闭 | 已开启 |
手动审查权限
| 设置项 | 值 | 默认 |
|---|---|---|
| 谁可以发起手动审查 | 拥有仓库写权限的所有人,或拥有写权限的指定用户或团队:最多 100 个 GitHub 用户名;在组织中,最多还可指定 30 个团队 slug。 | 拥有仓库写权限的所有人 |
更改会应用于保存之后请求的审查。排队中和运行中的审查保留原有设置。
仓库文件
HeyDeer 还会从被审查的仓库中读取这些文件。
| 文件 | 读取来源 | 规则与限制 |
|---|---|---|
AGENTS.md, CLAUDE.md | PR 自身的版本 | 任意目录。作用于所在目录及其子目录;层级更深的文件优先。目录中没有 AGENTS.md 时使用 CLAUDE.md。 |
.agents/checks/*.md | 基础分支 | 每个检查一个 Markdown 文件,直接放在 .agents/checks 中,文件名只能使用字母、数字、点、下划线和连字符。每个文件最大 16,000 字节,每次审查按文件名顺序最多应用 10 个匹配的检查。 |
.agents/skills/ | PR 自身的版本 | 在检查引用它时使用。文件夹名即技能名称:小写字母、数字和单个连字符,最多 64 个字符。 |
.gitattributes | 基础分支 | 标记为 linguist-generated 的文件不参与审查。 |
检查的 frontmatter
检查顶部可选的 YAML frontmatter 键:
| 键 | 值 | 作用 |
|---|---|---|
files, globs, paths | 一个 glob 模式或模式列表 | 检查适用的改动文件;在模式前加 ! 可排除文件。没有模式时,检查适用于所有改动文件。 |
skills, skill | 一个技能名称或名称列表 | 检查使用的技能,从 PR 中加载。缺少技能不会中止审查。 |
skip_extra_reviewers | true 或 false | 深度审查会在每个匹配的检查上投入更多精力。对于简单的检查,设为 true 即可像“标准”深度那样审查。 |