REVIEW.md
Coloque no REVIEW.md as orientações que só importam na revisão de código: o que verificar, o que deixar de lado e qual a gravidade de um problema. Outras ferramentas de revisão de código, como o Claude Code Review, leem o mesmo arquivo, então você pode manter o seu.
O que escrever
- O que verificar em todo pull request, como o escopo das consultas ao banco de dados.
- O que deixar de lado, como problemas que sua CI já relata. Mantenha as exclusões restritas e indique os caminhos que elas cobrem.
- Qual a gravidade de um tipo de problema para sua equipe, usando as gravidades do HeyDeer: Crítica, Alta, Média e Baixa.
REVIEW.md
# Review instructions
## Always check
- Database queries in src/api/ are scoped to the caller's
workspace.
- Log lines don't include email addresses or request bodies.
## Leave alone
- Formatting and lint issues. CI enforces them.
- Code in tests/fixtures/ that breaks production rules on purpose.
## Severity
- A migration that isn't backward compatible is High.
- Naming and refactoring suggestions are Low.Coloque as convenções de código no AGENTS.md, para que os agentes de código também as sigam. Coloque em uma verificação do repositório um requisito que o HeyDeer precisa verificar em todo pull request correspondente.
Arquivos na raiz e em subdiretórios
Adicione o REVIEW.md à raiz do repositório. Um diretório que precise de orientações próprias pode ter o próprio arquivo, como src/payments/REVIEW.md.
Um REVIEW.md vale para as alterações no próprio diretório e nos subdiretórios. Um arquivo mais profundo complementa os que estão acima dele e prevalece quando há conflito.
| Arquivo alterado | Arquivos que se aplicam, em ordem |
|---|---|
src/api/invoices.ts | REVIEW.md |
src/payments/refund.ts | REVIEW.md, src/payments/REVIEW.md |
O que as configurações definem
O REVIEW.md muda o que o HeyDeer procura e a gravidade de um problema, não como o HeyDeer relata os resultados. Para isso, use as configurações: Idioma da revisão, Escopo do feedback e Aprovação automática. Por exemplo, para publicar menos problemas encontrados de gravidade Baixa, escolha o escopo Conciso.
O REVIEW.md não se aplica às verificações do repositório: uma verificação correspondente sempre é executada, e só ela decide o que a viola.
Para ignorar arquivos gerados, marque-os no .gitattributes, assim eles ficam fora da revisão. Consulte Arquivos gerados.
Pull requests que editam o REVIEW.md
O HeyDeer lê o REVIEW.md do pull request, então um pull request que o edita é revisado com a versão que ele mesmo contém, e o HeyDeer nunca o aprova automaticamente. Coloque nas instruções de revisão as orientações que um pull request não deve poder alterar.
Se você vem do Claude Code Review
Seu REVIEW.md funciona como está. Restam estas diferenças:
- O HeyDeer lê o REVIEW.md do pull request, enquanto o Claude Code Review o lê da branch base.
- Important corresponde à gravidade Média ou acima, e Nit à Baixa.
- Limites no número de Nits não se aplicam. Escolha o escopo Conciso.
- O HeyDeer não segue inclusões como
@review-security.md. Mova as orientações delas para o REVIEW.md.