Documentation

Find your way

• Best practices: setups for teams with and without code review, rolling out, and reducing noise.
• Reviews on GitHub: reading a review, Fix with HeyDeer, the HeyDeer Review check, PR comment commands and follow-up reviews.
• Configure reviews: how settings work, automatic reviews and their filters, review depth, feedback scope, publishing and automatic approval.
• Teach HeyDeer your codebase: what HeyDeer reads, AGENTS.md, REVIEW.md, repository checks, skills, review instructions and connectors.
• Workspace and billing: members, Insights, the notification email, credits, plans, auto-reload and usage limits.
• Reference: every setting, GitHub App permissions, troubleshooting and the FAQ.

Something not working? See Troubleshooting.

How it works

What you see on a pull request

HeyDeer posts its findings as a GitHub review. Most are inline comments on the lines they’re about, with the severity, what goes wrong and often a suggested fix. Findings about code outside the diff appear in the review comment. See Reading a review.

src/sync/retry.ts

18for (let attempt = 1; ; attempt++) {

19 const res = await fetch(url);

20 if (res.ok) return res;

21 await sleep(backoff(attempt));

heydeerbot

🟠 High (Reliability): Retry loop never stops on a 404

fetchWithRetry() retries every failed response, including a 404 that never succeeds, so the sync job loops until it times out.

Suggested change

- if (res.ok) return res;

+ if (res.ok) return res;

+ if (res.status < 500 && res.status !== 429) throw new HttpError(res);

Learn more

Suggested fix: Retry only server errors and 429 responses, and throw for other client errors.

To have HeyDeer fix the findings you choose, select Fix with HeyDeer in the review. HeyDeer opens a separate PR for you to review and merge; see Fix with HeyDeer.

Why HeyDeer

• HeyDeer reviews each change independently of the person or agent that wrote it.
• It checks each finding against the code before posting it.
• It applies the conventions in your AGENTS.md and the requirements in your repository checks to the files they cover.

Set up HeyDeer

A new workspace starts on Free with 1,000 credits for its first month, then 300 each month. The Quickstart takes you from installing the GitHub App to your first review.

Then choose the setup that matches how your team merges today:

• Teams without code review: agents commit to main, or pull requests merge once CI passes.
• Teams with human reviewers: people review every pull request before it merges.