heydeer
Comece grátis
Comece

Início rápido

Conecte o HeyDeer ao GitHub e receba uma revisão de um dos seus pull requests.

Antes de começar

  • Uma conta do GitHub com acesso de escrita ao repositório que você quer que o HeyDeer revise.
  • Um pull request aberto nesse repositório.
  • Para uma organização, um proprietário que possa instalar o GitHub App do HeyDeer ou aprovar sua solicitação.

Um novo espaço de trabalho começa no Free. O primeiro mês começa na criação, com 1.000 créditos; os meses seguintes incluem 300. O Free executa 1 revisão por vez em cada repositório e não exige cartão de crédito. Quando os créditos acabarem, adicione créditos, espere pela próxima reposição mensal ou escolha um plano pago. Veja Planos e créditos adicionais.

1. Entre e escolha uma conta

Entre com o GitHub. Em Conecte seus repositórios, selecione sua conta pessoal ou organização. Se ela não aparecer na lista, selecione Instalar no GitHub ou Instalar em outra conta e escolha-a lá.

2. Adicione repositórios

Se o HeyDeer pedir repositórios, selecione Adicionar repositórios. No GitHub, escolha Only select repositories, selecione os repositórios a revisar e confirme. Se o HeyDeer já tiver acesso a eles, pule esta etapa.

Em uma organização, o GitHub pede a aprovação de um proprietário, a menos que você seja um. Consulte GitHub App e permissões ou, se uma conta ou um repositório não aparecer, Solução de problemas.

Quando o HeyDeer consegue acessar seus repositórios, ele começa a revisar cada push, até 5 vezes por pull request, e mostra Personalize suas revisões. Ali você pode escolher outra frequência ou profundidade de revisão, ou desativar Revisar pull requests automaticamente para revisar somente quando solicitado. Você pode mudar isso a qualquer momento; consulte Revisões automáticas.

3. Solicite uma revisão

Comente @heydeer review no pull request. Você também pode iniciar uma revisão pelo HeyDeer.

alexcomentou
@heydeer review
O HeyDeer adiciona 👀 ao seu comentário quando aceita a solicitação e publica a revisão quando termina.

Não apareceu 👀 nem resposta? Consulte Solução de problemas.

4. Veja os resultados no GitHub

O HeyDeer publica os problemas encontrados como comentários de revisão e informa o resultado na verificação HeyDeer Review. O link Details da verificação abre o relatório completo no HeyDeer. Consulte Como ler uma revisão.

Todas as verificações foram aprovadas
HeyDeer Review — Revisão concluída com problemas encontrados
CI / test — Bem-sucedida
Por padrão, a verificação passa mesmo quando a revisão tem problemas encontrados. Depois, você pode fazer com que ela bloqueie o merge.

Para que o HeyDeer corrija os problemas que você escolher, selecione Corrigir com HeyDeer no comentário de revisão. O HeyDeer abre um PR separado para você revisar e fazer o merge; consulte Corrigir com HeyDeer.

Próximos passos

  • Escolha quando o HeyDeer revisa. Se as revisões automáticas ainda estiverem desativadas, um administrador do espaço de trabalho pode escolher Uma vez por PR ou A cada push em Configurações do espaço de trabalho → Regras de revisão → Quando revisar; consulte Revisões automáticas.
  • Escolha uma configuração para sua equipe: Equipes sem revisão de código ou Equipes com revisores humanos.
  • Ensine seu código ao HeyDeer: convenções no AGENTS.md, orientações de revisão no REVIEW.md e requisitos que o HeyDeer precisa verificar como verificações do repositório. Veja O que o HeyDeer lê.