heydeer

Perguntas frequentes

Tudo o que as equipes perguntam antes e depois de começar: configuração, revisões, correções, preços e segurança.

Primeiros passos

Como configuro o HeyDeer?

Conecte o GitHub, escolha os repositórios e peça uma revisão:

  • Entre com o GitHub e escolha sua conta pessoal ou organização em Escolha onde estão seus repositórios. Se ela não aparecer, selecione Instalar no GitHub e escolha-a por lá.
  • No GitHub, escolha Only select repositories, selecione os que serão revisados e confirme. Em uma organização, o GitHub pede a aprovação de um proprietário, a menos que você seja um.
  • Decida se o HeyDeer revisa por conta própria: deixe Revisar pull requests automaticamente ativado para revisar cada push, até 5 vezes por pull request, ou desative para revisar só quando alguém pedir.
  • Comente @heydeer review em um pull request aberto.

Você precisa de acesso de escrita ao repositório. Um novo espaço de trabalho começa no plano gratuito, sem cartão de crédito, e os problemas encontrados chegam como comentários de revisão no pull request.

Saiba mais: Início rápido
O HeyDeer funciona com GitLab ou Bitbucket?
O HeyDeer funciona com o GitHub, em repositórios públicos e privados, para organizações e contas pessoais. Ele é instalado como um GitHub App, e você escolhe quais repositórios ele pode ler e revisar, então o acesso fica limitado ao código que você quer revisar. Cada espaço de trabalho pertence a uma conta do GitHub; para conectar outra, selecione Adicionar espaço de trabalho no menu do espaço de trabalho.
Saiba mais: GitHub App e permissões
Preciso configurar algo antes da primeira revisão?

Você pode pedir uma revisão logo depois de conectar. O HeyDeer lê as alterações do pull request no contexto do repositório inteiro, junto com o título, a descrição e a discussão do PR, e toda revisão já procura bugs e problemas de segurança.

Quando suas primeiras revisões mostrarem uma lacuna, adicione orientações no lugar certo:

  • AGENTS.md para como seu código funciona e as convenções que ele segue; os agentes de programação também o seguem.
  • REVIEW.md para o que as revisões devem procurar, o que devem deixar de lado e a gravidade de cada problema.
  • Uma verificação do repositório para um requisito que o HeyDeer deve verificar em todo pull request que altere determinados arquivos.
  • Instruções de revisão para orientações que um pull request não pode alterar ou que valem para todos os repositórios.
Saiba mais: O que o HeyDeer lê
Quando o HeyDeer começa a revisar pull requests?

Assim que alguém pede: comente @heydeer review em um pull request, selecione Iniciar revisão na página Histórico de revisões ou selecione Re-run na verificação HeyDeer Review. Um novo espaço de trabalho começa em Somente manual, e logo depois da configuração o HeyDeer pergunta se deve revisar automaticamente.

Um administrador do espaço de trabalho pode mudar a frequência a qualquer momento em Configurações do espaço de trabalho → Regras de revisão → Quando revisar:

  • Uma vez por PR revisa um pull request que atenda aos filtros até que uma revisão seja concluída com sucesso.
  • A cada push revisa quando o pull request atende aos seus filtros pela primeira vez e depois de cada push que adiciona commits, até 5 vezes por padrão.

Por padrão, as revisões automáticas ignoram rascunhos, forks e atualizações de dependências.

Saiba mais: Revisões automáticas
Por que o HeyDeer diz que está aguardando a aprovação de um proprietário do GitHub?
Em uma organização do GitHub, só um proprietário pode instalar o GitHub App do HeyDeer; por isso, quando outra pessoa o conecta, o GitHub envia uma solicitação aos proprietários e o HeyDeer mostra Aguardando a aprovação de um proprietário do GitHub. Os administradores do espaço de trabalho podem aproveitar a espera para ajustar as configurações, para que as revisões funcionem do jeito que você quer desde o início. Assim que um proprietário aprova no GitHub, o espaço de trabalho se conecta sozinho e o HeyDeer envia um e-mail para o endereço de notificação do espaço de trabalho.
Saiba mais: GitHub App e permissões
Como adiciono mais repositórios?
Selecione Adicionar repositórios na página Repositórios, ou Gerenciar acesso ao GitHub em Configurações do espaço de trabalho → Conexão com o GitHub, e escolha os repositórios no GitHub. Só um proprietário da conta do GitHub pode salvar a alteração; as outras pessoas veem Pedir ajuda à equipe, com uma solicitação que podem copiar e enviar a um proprietário. Os repositórios adicionados seguem os padrões do espaço de trabalho em Regras de revisão, então são revisados como os demais desde o primeiro momento. Para incluir também os repositórios criados depois, escolha Todos os repositórios no GitHub.
Saiba mais: GitHub App e permissões
Como implantar o HeyDeer na equipe?

Introduza o HeyDeer em etapas e deixe que ele controle os merges quando sua equipe confiar nos resultados:

  • Teste em alguns pull requests: com as revisões automáticas desativadas, comente @heydeer review em um punhado de pull requests de tipos diferentes e compare os problemas encontrados com os dos seus revisores.
  • Preencha as lacunas que essas revisões mostrarem: convenções no AGENTS.md, requisitos em verificações do repositório e prioridades em instruções de revisão.
  • Ative as revisões automáticas em um ou dois repositórios (selecione-os em Repositórios e depois Alterar frequência) e, em seguida, no espaço de trabalho inteiro.
  • Torne obrigatória a verificação HeyDeer Review, decida sobre a aprovação automática e, em um plano pago, configure a recarga automática e um limite de uso.

Passe para a próxima etapa quando sua equipe agir sobre a maioria dos problemas encontrados e as revisões terminarem sem observações da revisão. Os administradores do espaço de trabalho alteram as configurações; qualquer pessoa com acesso de escrita pode pedir revisões.

Saiba mais: Como implantar na equipe
Posso testar o HeyDeer antes que minha equipe veja?
Sim. Em Configurações do espaço de trabalho → Regras de revisão → Publicar resultados, desative Publicar verificação do GitHub e Publicar comentários de revisão no PR. Depois peça revisões com Iniciar revisão na página Histórico de revisões e leia os resultados lá; eles aparecem só no HeyDeer. As revisões continuam sendo executadas e usam créditos. Ative as duas opções de novo quando quiser compartilhar as revisões com sua equipe.
Saiba mais: Publicar resultados
Como sei que o HeyDeer recebeu meu pedido?
O HeyDeer adiciona 👀 ao seu comentário quando aceita o pedido, remove quando a revisão termina e publica a revisão no pull request. Enquanto isso, a verificação HeyDeer Review mostra o progresso da revisão. Se o HeyDeer não conseguir executar a revisão, ou se ela falhar ou for cancelada, o HeyDeer responde ao seu comentário. Um comentário que não recebe 👀 não foi lido como comando: publique-o como texto simples em um novo comentário, e não em código, em uma citação ou em uma edição.
Saiba mais: Comandos em comentários do PR
Onde encontro os resultados da revisão?
No pull request. O HeyDeer publica os problemas encontrados como uma revisão do GitHub, com um comentário em linha nas linhas a que cada problema se refere; um problema em código fora do diff, como um chamador não alterado que a mudança quebra, aparece em Outros problemas encontrados no corpo da revisão. A verificação HeyDeer Review informa o resultado, e o link Detalhes dela abre o relatório completo no HeyDeer, onde a página Histórico de revisões lista todas as revisões. O botão Roteiro abre um guia da alteração que agrupa as edições relacionadas e destaca as importantes, para quem for ler o pull request em seguida.
Saiba mais: Como ler uma revisão
O HeyDeer revisa pull requests abertos por agentes de programação?
Sim. Pull requests de agentes de programação e de outros bots são revisados como qualquer outro. O HeyDeer revisa cada um de forma independente do agente que o escreveu, o que importa porque um agente tende a deixar passar os próprios erros, e nos pushes seguintes ele verifica de novo as preocupações que levantou antes. Os filtros de revisão automática padrão ignoram só rascunhos, forks e atualizações de dependências de bots como Dependabot e Renovate. Para fazer merge dos pull requests de agentes assim que o HeyDeer os aprovar, siga a configuração para equipes sem revisão de código.
Saiba mais: Equipes sem revisão de código

Ainda precisa de ajuda?

Converse com a equipe que desenvolve o HeyDeer ou mande um e-mail.