Boas práticas
Como reduzir o ruído
Se o HeyDeer publica mais do que sua equipe quer ler, encontre abaixo o tipo de ruído e aplique a correção correspondente. As primeiras linhas trazem mais resultado com menos esforço.
Correções
| Ruído | Correção | Detalhes |
|---|---|---|
| Muitos problemas encontrados sobre os quais você não agiria | Mude o Escopo do feedback para Conciso. Para comparar escopos antes, abra uma revisão recente no HeyDeer e use Prévia do escopo do feedback. | Escopo do feedback |
| Comentários em código gerado | Marque os arquivos como linguist-generated no .gitattributes da branch base. | O que o HeyDeer lê |
| Revisões de pull requests de bots ou descartáveis | Adicione filtros de revisão automática, como Conta do autor Não é nenhum de Bot, ou Rótulos do PR Não é nenhum de skip-review. | Filtros de revisão |
| Um problema encontrado que você decidiu não corrigir | Responda com o motivo ou resolva a conversa. Uma decisão de alguém com acesso de escrita faz o HeyDeer parar de levantá-lo. | Revisões de acompanhamento |
| Um tipo de comentário que ninguém atende | Nas instruções de revisão ou no AGENTS.md, diga sobre o que não comentar, de forma específica e com um motivo. Evite regras amplas como “Não comente sobre desempenho”. | Como escrever orientações de revisão |
| Uma verificação disparando em arquivos que não têm relação com ela | Restrinja os padrões de files dela e exclua testes ou fixtures. | Como escrever verificações eficazes |
| Revisões de acompanhamento a cada push | Mantenha Revisar apenas as alterações novas ativado e defina um Máximo de revisões automáticas por PR, ou use Uma vez por PR. | Revisões automáticas |
| Uma conversa longa no pull request | Mantenha Marcar conversas atendidas do HeyDeer como resolvidas ativado, ou desative Publicar comentários de revisão no PR para que a verificação HeyDeer Review traga a revisão. | Publicação dos resultados |
Exemplos
Arquivos gerados no .gitattributes:
src/generated/** linguist-generated
*.pb.go linguist-generated=trueRegras específicas sobre o que deixar de lado:
## Leave alone
- Files under scripts/one-off/. They run once by hand and are deleted.
- Missing input validation in internal/admin-cli/. It only runs
locally with trusted input.