heydeer
Boas práticas

Equipes sem revisão de código

Use esta configuração quando as alterações chegam à main sem que ninguém as leia, por exemplo, quando agentes fazem commit direto na main ou quando os pull requests são mesclados assim que o CI passa. O HeyDeer revisa cada push, e o GitHub faz o merge do pull request assim que o HeyDeer o aprova.

Configuração recomendada

Um agente abre um pull request
O HeyDeer revisa cada push
A verificação passa e o HeyDeer aprova
O GitHub faz o merge do pull request
Se o HeyDeer relatar problemas encontrados, a verificação é reprovada e nada é mesclado. O agente faz push de uma correção, e o HeyDeer revisa os novos commits.
  1. Faça os agentes enviarem as alterações para uma branch e abrirem um pull request para cada alteração, em vez de fazer commit na main.
  2. Em Configurações do espaço de trabalho → Regras de revisão → Quando revisar, selecione A cada push. Consulte Revisões automáticas.
  3. Em Publicar resultados, ative Reprovar a verificação quando forem encontrados problemas. Consulte A verificação HeyDeer Review.
  4. Em Publicar resultados, ative Aprovação automática. Assim, o HeyDeer aprova um pull request quando uma revisão completa não deixa nenhum problema encontrado. Consulte Aprovação automática.
  5. Decida quem aprova mudanças de risco alto. Por padrão, pull requests de risco alto aguardam uma pessoa. Para que o HeyDeer também os aprove, defina PRs que o HeyDeer pode aprovar como PRs de qualquer nível de risco.
  6. Nas regras de branch do GitHub para a main, ative Require a pull request before merging com 1 aprovação obrigatória. Ative também Dismiss stale pull request approvals when new commits are pushed.
  7. Nas mesmas regras, torne obrigatória a verificação HeyDeer Review junto com as verificações do seu CI.
  8. Ative Allow auto-merge nas configurações do repositório no GitHub. Depois, ative o auto-merge em cada pull request ou faça o agente executar gh pr merge --auto --squash depois de abrir um.
HeyDeer aprovou estas alterações
Todas as verificações foram aprovadas
HeyDeer Review — Revisão concluída — nenhum problema encontrado
CI / test — Bem-sucedida
O auto-merge está ativado: o GitHub fará o merge deste pull request assim que todos os requisitos forem atendidos.
Quando o HeyDeer aprova e todas as verificações obrigatórias passam, o GitHub faz o merge do pull request.

Deixe o agente agir sobre os problemas encontrados

O HeyDeer publica os problemas encontrados como uma revisão no pull request, e a verificação HeyDeer Review traz o relatório completo. Faça o agente ler a revisão depois de cada push, corrigir os problemas e fazer push de novo. Em seguida, o HeyDeer revisa os novos commits.

Para recusar um problema encontrado, alguém com acesso de escrita explica a decisão na conversa do problema ou resolve a conversa e depois comenta @heydeer review. Consulte Recusar um problema encontrado.

Se preferir que o HeyDeer corrija em um PR separado os problemas que você escolher, selecione Corrigir com HeyDeer na revisão; consulte Corrigir com HeyDeer.

Escrever seus padrões como verificações

Os agentes atendem a um requisito com mais confiabilidade quando a revisão o exige. Adicione um arquivo Markdown em .agents/checks/ para cada requisito, e o HeyDeer o aplica a todo pull request que altera arquivos correspondentes. Consulte Verificações do repositório.

.agents/checks/tenant-scope.md

---
files:
  - "src/db/**/*.ts"
  - "!**/*.test.ts"
---
Every query that reads or writes customer data must be
scoped to one tenant, taken from the request context and
never from request parameters.

Por que uma revisão separada ajuda

O CI só detecta o que seus testes cobrem. Sem revisão, dois tipos de problema passam despercebidos:

  • O modelo que escreveu o código tende a aceitar o próprio raciocínio e a deixar passar os próprios erros, mesmo quando você pede que ele confira o trabalho.
  • Quando um agente modifica o mesmo código repetidamente, cada alteração pode quebrar silenciosamente algo que uma anterior tinha acertado.

O HeyDeer revisa cada pull request de forma independente do agente que o escreveu e confere cada problema encontrado no código antes de publicá-lo. Nos pushes seguintes, as revisões de acompanhamento verificam novamente as preocupações anteriores.