heydeer Sign in
Teach HeyDeer your codebase

Review instructions

Review instructions tell HeyDeer your team’s priorities, conventions, and terms. Unlike AGENTS.md and repository checks, they are saved in HeyDeer, for the whole organization or for one repository.

Organization and repository instructions

ScopeWhereApplies to
OrganizationOrganization settings → Review instructionsEvery repository in the workspace
RepositoryRepositories → (a repository) → Review instructionsThat repository, after the organization instructions
  • Write plain text or Markdown, up to 12,000 characters for each scope.
  • When the two conflict, the repository instructions win. A repository’s page previews both in order.
  • To use only the organization instructions for a repository, choose Use organization instructions only and save.
  • Only workspace admins can edit instructions.
  • Changes apply to reviews requested after you save.
  • Don’t put passwords, tokens, or other secrets in instructions.

Example

Focus on data isolation and API compatibility.

- A "workspace" is the tenant. Every query on customer
  data must be scoped to one.
- Treat changes under src/billing/ as high risk.
- Do not comment on formatting; our formatter handles it.

For advice on what to write, see Writing review guidance.