Como ler uma revisão
Saiba o que significa cada parte de uma revisão do HeyDeer, no GitHub e no HeyDeer.
O que o HeyDeer publica
O HeyDeer publica os problemas encontrados como uma revisão de pull request do GitHub, com um comentário em linha nas linhas de que cada problema trata.
O corpo da revisão começa com o resultado e traz links para as preocupações anteriores que ainda precisam de atenção. Ele termina com uma seção recolhida Sobre esta revisão: o resumo da revisão, o nível de risco, a Profundidade da revisão, a Origem e os links Ver no HeyDeer e Configuração.
O corpo também traz as observações da revisão, as perguntas em Precisa de esclarecimento e os problemas encontrados que não podem ficar em linha. O GitHub só aceita comentários em linha em linhas do diff, então um problema em outro código, como um chamador não alterado que a mudança quebra, aparece em Outros problemas encontrados.
O relatório completo fica na verificação HeyDeer Review e na página da revisão no HeyDeer. Se uma revisão for longa demais para um único comentário do GitHub, o relatório completo traz o restante.
O HeyDeer só aprova um pull request quando Aprovação automática está ativada.
Com Publicar comentários de revisão no PR desativado, apenas a verificação traz a revisão. Consulte Publicar resultados.
O HeyDeer escreve tudo o que publica no Idioma da revisão do repositório.
Como um problema encontrado é apresentado
| Parte | O que mostra |
|---|---|
| Título | Gravidade, categoria e título, por exemplo 🟠 Alta (Confiabilidade): Loop de novas tentativas nunca para em um 404. |
| Explicação | O que está errado e o que isso causa. |
| Alteração sugerida | Uma edição exata que você pode fazer commit, quando o comentário está nas linhas que ela substitui. |
| Saiba mais | Recolhido: por que acontece, a correção sugerida, um diff somente leitura de uma alteração que não pode ser commitada aqui e a verificação do repositório que o apontou. |
| Código afetado | Um link para as linhas, quando o comentário não está nelas. |
A gravidade (Crítica, Alta, Média ou Baixa) é o impacto do problema encontrado. Ela é independente da confiança, que indica o quanto o HeyDeer tem certeza de que o problema é real. Para publicar menos ou mais problemas, altere o Escopo do feedback, que combina as duas.
Para que o HeyDeer faça as alterações em um PR separado para você revisar e fazer o merge, use Corrigir com HeyDeer.
Categorias
A categoria é o que o problema encontrado prejudica, independente da gravidade. Quando várias se aplicam, o HeyDeer escolhe a primeira desta tabela.
| Categoria | O que prejudica |
|---|---|
| Segurança | Alguém pode fazer ou ver o que não deveria. |
| Correção | O código dá um resultado errado no uso normal. |
| Confiabilidade | O código falha diante de erros, concorrência, carga, novas tentativas ou falhas parciais. |
| Desempenho | O código consome tempo ou recursos demais. |
| Manutenibilidade | Nada falha, mas o código fica mais difícil de alterar, testar ou ler. |
Observações da revisão
Quando algo limitou uma revisão, o HeyDeer explica o motivo em Observações da revisão, no corpo da revisão, no resumo da verificação e na página da revisão.
| Observação da revisão | O que fazer |
|---|---|
| Alguns problemas foram omitidos | Uma revisão mantém apenas os problemas encontrados de maior prioridade, com base na confiança e na gravidade. Corrija ou recuse os problemas mostrados e solicite outra revisão. |
| Verificações do repositório correspondentes em excesso | O HeyDeer aplica as verificações correspondentes na ordem dos nomes de arquivo e ignora as demais. Restrinja os padrões de arquivo delas e solicite outra revisão. |
| Algumas verificações do repositório são inválidas | O HeyDeer ignora a verificação inválida e a indica. Corrija-a e solicite outra revisão. |
| Algumas verificações do repositório não puderam ser concluídas | Solicite outra revisão. |
| Alguns problemas encontrados ou preocupações anteriores não puderam ser avaliados por completo | Solicite outra revisão para obter um resultado completo. |
Uma revisão com observações está incompleta, então o HeyDeer não a aprova e a verificação dela não informa sucesso.
Para mais ajuda com as observações da revisão, consulte Solução de problemas.
Roteiro
Uma revisão no GitHub tem um botão Roteiro ao lado de Corrigir com HeyDeer. Ele abre o roteiro no HeyDeer, com as alterações relacionadas agrupadas e as alterações importantes destacadas. Cada grupo diz o que verificar e mostra o código como ele está no commit revisado.
Grupos relacionados ficam na mesma aba. Uma aba cujas alterações abrangem várias partes do sistema, como o navegador, um servidor e um banco de dados, começa com um diagrama: como essas partes se conectam ou os passos entre elas, em ordem. Selecione o diagrama para ampliá-lo.
Os grupos são marcados como Leitura obrigatória, Leitura recomendada ou Leitura rápida. Mudanças fora do caminho principal, como testes, documentação e edições repetidas, aparecem em Outras com o motivo. Os arquivos gerados que a revisão pulou aparecem no fim de Outras, e uma revisão posterior do mesmo PR marca os grupos que mudaram desde a última revisão.
O roteiro explica a mudança; não é uma lista de problemas encontrados. A página da revisão no HeyDeer também o abre com Roteiro. Desative-o em Roteiro nas regras de revisão.
Marque Visto em um arquivo para recolhê-lo. Quando todas as partes do arquivo estão marcadas, o HeyDeer também marca o arquivo como visualizado no GitHub, e o GitHub limpa essa marca quando o arquivo muda.
A revisão no HeyDeer
Toda revisão tem uma página no HeyDeer. Abra-a em Histórico de revisões, pelo link Details da verificação ou por Ver no HeyDeer no corpo da revisão.
A página da revisão mostra a Origem e se a revisão cobriu Alterações novas ou o PR inteiro. Ela também lista todos os problemas encontrados dentro do escopo do feedback e as preocupações em Recusado na discussão.
Enquanto uma revisão é executada, Progresso da revisão mostra as etapas dela e o que cada revisor está fazendo. Depois que ela termina, o painel recolhido Atividade da revisão guarda cada etapa, quanto tempo a revisão levou e o que cada revisor fez.
Quando outro escopo do feedback manteria problemas encontrados diferentes, você pode ver a prévia sem alterar nada: escolha o escopo ao lado de Problemas encontrados ou selecione Ver prévia abaixo de um resultado sem problemas encontrados. Alguém com acesso de escrita pode interromper uma revisão com Cancelar revisão; os créditos já usados não são devolvidos.