Documentação
O HeyDeer revisa pull requests do GitHub com base no seu código e nos padrões da sua equipe. Ele publica os problemas encontrados no pull request, informa o resultado em uma verificação que você pode tornar obrigatória e, quando você pede, corrige os problemas que você escolher.
Encontre o que procura
- Boas práticas: configurações para equipes com e sem revisão de código, implantação na equipe e redução de ruído.
- Revisões no GitHub: como ler uma revisão, Corrigir com HeyDeer, a verificação HeyDeer Review, comandos em comentários do PR e revisões de acompanhamento.
- Configurar revisões: como funcionam as configurações, revisões automáticas e seus filtros, profundidade da revisão, escopo do feedback, publicação e aprovação automática.
- Ensine seu código ao HeyDeer: o que o HeyDeer lê, AGENTS.md, REVIEW.md, verificações do repositório, skills, instruções de revisão e conectores.
- Espaço de trabalho e cobrança: membros, Análises, e-mail de notificação, créditos, planos, recarga automática e limites de uso.
- Referência: todas as configurações, permissões do GitHub App, solução de problemas e perguntas frequentes.
Algo não está funcionando? Consulte Solução de problemas.
Como funciona
O que você vê em um pull request
O HeyDeer publica os problemas encontrados como uma revisão do GitHub. A maioria aparece como comentários em linha nas linhas de que tratam, com a gravidade, o que dá errado e, muitas vezes, uma sugestão de correção. Os problemas em código fora do diff aparecem no comentário da revisão. Consulte Como ler uma revisão.
Para que o HeyDeer corrija os problemas que você escolher, selecione Corrigir com HeyDeer na revisão. O HeyDeer abre um PR separado para você revisar e fazer o merge; consulte Corrigir com HeyDeer.
Por que o HeyDeer
- O HeyDeer revisa cada alteração de forma independente da pessoa ou do agente que a escreveu.
- Ele confere cada problema encontrado no código antes de publicá-lo.
- Ele aplica as convenções do seu AGENTS.md e os requisitos das suas verificações do repositório aos arquivos que eles cobrem.
Configure o HeyDeer
Um novo espaço de trabalho começa no Free com 1.000 créditos no primeiro mês e 300 por mês depois. O guia de início rápido acompanha você desde a instalação do GitHub App até sua primeira revisão.
Depois, escolha a configuração que corresponde a como sua equipe faz merge hoje:
- Equipes sem revisão de código: agentes fazem commit direto na main, ou os pull requests são mesclados assim que o CI passa.
- Equipes com revisores humanos: pessoas revisam cada pull request antes do merge.