Como ler uma revisão
O HeyDeer publica os problemas encontrados como uma revisão de pull request do GitHub, com um comentário inline nas linhas de que cada problema trata.
O que o HeyDeer publica
A revisão no GitHub não tem resumo. O resumo e a lista completa de problemas encontrados ficam na verificação HeyDeer Review e no HeyDeer.
O comentário da revisão contém apenas os avisos da revisão, os problemas encontrados adicionais e o eventual motivo da aprovação. Uma revisão sem nada a publicar não adiciona comentário. Se a revisão for longa demais para o GitHub, o HeyDeer deixa alguns problemas encontrados de fora e adiciona um link Ver todos os apontamentos no HeyDeer.
O HeyDeer só aprova um pull request quando Aprovação automática está ativada, e não repete um problema que a discussão já levantou. Consulte Revisões de acompanhamento.
Com Publicar comentários de revisão no PR desativado, apenas a verificação traz a revisão. Consulte Publicação dos resultados.
Como um problema encontrado é apresentado
| Parte | O que mostra |
|---|---|
| Título | Gravidade e título, por exemplo HIGH: o loop de novas tentativas nunca para em um 404. |
| Explicação | Qual é o problema e o que ele causa. |
| Correção sugerida | Como corrigir, em palavras. |
| Alteração sugerida | Uma edição exata, como uma sugestão do GitHub ou um diff somente leitura. |
| Verificação | A verificação do repositório que o levantou. |
| 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 e reflete o impacto, independentemente da confiança do HeyDeer. Para publicar menos ou mais problemas encontrados, altere o Escopo do feedback, que filtra por confiança.
Uma sugestão pronta para commit só aparece quando o comentário fica exatamente sobre as linhas que ela substitui; nos demais casos, a alteração é um diff somente leitura. O HeyDeer nunca executa seu formatador nem seus testes, então leia uma sugestão antes de fazer commit dela.
O GitHub só aceita comentários inline em linhas do diff. Um problema encontrado em outro código, como um chamador não alterado que a mudança quebra, vai para o comentário da revisão, em Apontamentos adicionais.
Avisos da revisão
Quando algo limitou uma revisão, o comentário da revisão, a verificação e o HeyDeer mostram Avisos da revisão.
| Aviso | O que fazer |
|---|---|
| Problemas encontrados com menor confiança foram omitidos | Uma revisão mantém os 30 problemas encontrados com maior confiança. Resolva-os e depois solicite outra revisão. |
| Apenas as 10 primeiras verificações foram selecionadas | No máximo 10 verificações do repositório se aplicam, na ordem dos nomes de arquivo. Restrinja os padrões de arquivo delas. |
Este pull request altera .agents/, e a nova configuração de verificações é inválida | Corrija a configuração antes do merge, ou o HeyDeer não poderá revisar pull requests para essa branch. |
| Alguns problemas encontrados ou avaliações de conversas eram inválidos ou incompletos | Solicite outra revisão para obter um resultado completo. |
Uma revisão com aviso está incompleta: o HeyDeer não a aprova, a verificação dela não informa sucesso e a próxima revisão cobre o pull request inteiro.
Idioma da revisão
O Idioma da revisão define o idioma dos problemas encontrados, dos resumos, dos avisos e das respostas do HeyDeer nas conversas dele. Escolha inglês (o padrão), chinês simplificado, japonês, espanhol, coreano, português (Brasil) ou alemão. O código e os caminhos de arquivo não mudam.
Defina em Configurações da organização → Regras de revisão, em Como revisar, ou nas Regras de revisão de um repositório.
A revisão no HeyDeer
Toda revisão tem uma página no HeyDeer. Abra-a em Revisões, pelo link Details da verificação ou por Ver todos os apontamentos no HeyDeer. Ela mostra o que disparou a revisão, se ela cobriu Alterações novas ou PR inteiro, os Créditos usados, todos os problemas encontrados dentro do escopo do feedback e as preocupações listadas em Recusado na discussão.
Prévia do escopo do feedback mostra quais problemas encontrados cada escopo do feedback manteria, sem alterar nada. 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.