开始使用

GitHub App 与权限

HeyDeer 通过安装在你的个人账号或组织上的 GitHub App 工作。安装范围决定 HeyDeer 可以读取和审查哪些仓库。

安装 HeyDeer

每个工作区属于一个 GitHub 账号。创建工作区时会跳转到 GitHub 安装该应用；在组织中，只有所有者才能安装。

否则，GitHub 会向所有者发送请求。请求待处理期间，HeyDeer 会显示“正在等待 GitHub 所有者批准”，而管理员已经可以配置工作区。所有者批准后，工作区会自动连接，HeyDeer 会向通知邮箱发送邮件。如果你是通过“添加 GitHub 组织”发起的请求，HeyDeer 会为你设置该组织的工作区，并将你设为管理员。

选择仓库

选择“Only select repositories”（仅选择部分仓库）并挑选要审查的仓库；“All repositories”（所有仓库）还会包括之后新建的仓库。要更改选择，请打开“组织设置 → GitHub 连接”，然后选择“管理 GitHub 访问权限”。只有该账号的 GitHub 所有者才能在那里保存更改。

新添加的仓库遵循组织的审查规则。只有当某人和该安装在 GitHub 上都能访问某个仓库时，此人才能在 HeyDeer 中看到该仓库及其审查；请求审查需要写权限。参见 PR 评论命令。

找不到组织？请选择“添加 GitHub 组织”。对于使用 SSO 的组织，请先在 GitHub 上通过 SSO 登录，然后选择“重新授权 GitHub”。

权限

权限	访问级别	HeyDeer 的用途
Contents	读写	读取代码和历史。GitHub 要求具备写入权限才能解决审查讨论；HeyDeer 只将其用于自己发起的讨论。
Pull requests	读写	读取 PR，并发布审查、评论和回复。
Checks	读写	显示 HeyDeer Review 检查，并接收其按钮发出的请求。
Issues	只读	接收 PR 评论命令并读取关联 Issue。
Metadata	只读	读取仓库基本信息以及谁拥有写权限。
Members（组织）	只读	列出工作区成员，并匹配成员和团队规则。
Email addresses（账号）	只读	建议将你已验证的邮箱用作通知邮箱。

如果 HeyDeer 需要的某项权限尚未在安装中授予，“组织设置 → GitHub 连接”会显示“需要 GitHub 权限”。选择“查看权限请求”，以便所有者在 GitHub 上接受。