快速入门

开始之前

• 对要审查的仓库拥有写权限的 GitHub 账号。
• 该仓库中一个处于打开状态的 PR。
• 如果是组织，还需要一位能安装 HeyDeer GitHub App 或批准你请求的所有者。

新工作区从免费套餐开始。首月从创建当天算起，包含 1,000 积分；之后每月包含 300 积分。免费套餐允许每个仓库同时运行 1 个审查，无需信用卡。积分用完后，可以购买积分、等待下次每月积分更新，或选择付费套餐。参见套餐与加购积分。

1. 登录并选择账号

使用 GitHub 登录。在连接你的仓库下，选择你的个人账号或组织。如果没有列出，请选择在 GitHub 上安装或安装到其他账号，并在 GitHub 上选择该账号。

2. 添加仓库

如果 HeyDeer 要求添加仓库，请选择添加仓库。在 GitHub 上选择 Only select repositories（仅选择部分仓库），挑选要审查的仓库并确认。如果 HeyDeer 已经可以访问这些仓库，请跳过此步骤。

在组织中，除非你本人就是所有者，否则 GitHub 会请所有者批准。参见 GitHub App 与权限；如果找不到账号或仓库，参见故障排除。

HeyDeer 可以访问你的仓库后，会开始在每次推送时审查，每个 PR 最多 5 次，并显示自定义审查方式。你可以在那里选择其他审查时机或审查深度，或关闭自动审查 PR，只在有人发起时审查。你可以随时更改；参见自动审查。

3. 发起审查

在 PR 上评论 @heydeer review。你也可以从 HeyDeer 发起审查。

没有 👀 或没有回复？参见故障排除。

4. 在 GitHub 上查看结果

HeyDeer 以审查评论的形式发布发现的问题，并在 HeyDeer Review 检查中报告结果。点击检查的 Details 链接，可在 HeyDeer 中打开完整报告。参见解读审查结果。

如需让 HeyDeer 修复你选择的问题，请在审查评论中选择用 HeyDeer 修复。HeyDeer 会创建一个独立的 PR，由你检查并合并；参见用 HeyDeer 修复。

后续步骤

• 选择 HeyDeer 何时审查。如果自动审查仍未开启，工作区管理员可以在工作区设置 → 审查规则 → 何时审查中选择每个 PR 审查一次或每次推送时审查；参见自动审查。
• 为团队选择配置：没有代码审查的团队或有人工审查员的团队。
• 让 HeyDeer 了解你的代码库：约定写入 AGENTS.md，审查指导写入 REVIEW.md，HeyDeer 必须核实的要求写成仓库检查。参见 HeyDeer 读取的内容。