Instruções de revisão

Adicionar instruções

1. Abra Configurações do espaço de trabalho → Instruções de revisão. Para um único repositório, abra Repositórios → (um repositório) → Instruções de revisão.
2. Escreva em texto simples ou Markdown, com até 12.000 caracteres.
3. Selecione Salvar instruções do espaço de trabalho ou Salvar instruções do repositório.

• As instruções do espaço de trabalho valem para todos os repositórios. As instruções do repositório são somadas a elas e prevalecem quando as duas entram em conflito.
• Na página de um repositório, Prévia das instruções combinadas mostra as duas em ordem.
• As alterações valem para revisões solicitadas depois que você salva.
• Apenas administradores do espaço de trabalho podem editar as instruções.
• Não coloque senhas, tokens ou outros segredos nas instruções.

O que deve ficar nas instruções

As instruções guardam orientações que só importam quando o HeyDeer revisa: o que priorizar, o que deixar de lado, os termos que sua equipe usa e como redigir o feedback.

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.

Para guardar essas orientações no repositório, ao lado do código a que se referem, use o REVIEW.md. Um pull request pode alterar o REVIEW.md, então deixe nas instruções o que ele não deve poder alterar.

As instruções têm precedência sobre o REVIEW.md, o AGENTS.md e as skills, mas não podem impedir que uma verificação do repositório seja executada. Consulte Quando as orientações entram em conflito.

Escrever instruções eficazes

Deixe o HeyDeer revisar alguns pull requests antes de escrever qualquer coisa. Adicione instruções aos poucos, cada uma para algo que ele costuma deixar passar ou para um comentário indesejado recorrente, e leia as próximas revisões para ver o efeito.

• Agrupe as instruções sob alguns títulos, como Prioridades, Deixar de lado, Termos e Feedback.
• Escreva uma instrução por item e cite os caminhos, as funções e as bibliotecas de que ela trata.
• Adicione o motivo quando ele não for óbvio.
• Mantenha as exclusões restritas: “Não comente sobre arquivos em scripts/one-off/”, e não “Não comente sobre scripts”, o que também esconde bugs reais.
• Para definir como o HeyDeer relata os resultados, use as configurações: Idioma da revisão, Escopo do feedback e Aprovação automática.

## Priorities

- Code under src/payments/ is high risk. Look hardest at retries,
  refunds and anything that could charge a customer twice.

## Leave alone

- Files under scripts/one-off/. They run once by hand and are deleted.
- Formatting. The formatter runs in CI.

## Terms

- A "workspace" is a customer account, not a folder on disk.

## Feedback

- Name the input that triggers a bug, and suggest the smallest fix.

Se uma instrução parecer ignorada, consulte Solução de problemas.