Reportar erros de maneira mais eficaz

⚠️ elaborado com base na publicação “Comunicando erros e tirando dúvidas em fóruns”, da escola Alura.

---

Como fazer perguntas mais eficientes em fóruns, canais e sites sobre os erros encontrados no desenvolvimento dos projetos

O que uma boa pergunta deve ter?

• trecho do código
• mensagem de erro
• captura de tela
• boa comunicação

E como fazer?

1. Encontrar o erro
2. Produzir material ilustrativo
3. Elaborar a mensagem
4. Revisar a mensagem antes de enviar

Primeiro passo: encontrar o erro

Uncaught TypeError: input.setCustomValidit is not a function

• O console do navegador é uma boa ferramenta para exibir os erros da aplicação
• Ele permite copiar o texto exibido ou tirar um print para utilizar na mensagem

Segundo passo: produzir material ilustrativo

Uma imagem fala mais que mil palavras?

• Sempre que possível, capture imagens da tela (fotos / vídeos)
• Demonstre claramente
  • detalhes do código
  • mensagem de erro
  • aplicação no navegador / terminal /compilador
• Se achar necessário, faça marcações na imagem realçando pontos chaves do problema

Nem todos os fóruns de “discussão” permitem fazer upload de imagens, mas podem aceitar links externos.
Nesses casos, é possível publicar a imagem em alguma plataforma que ofereça este tipo de serviço e copiar o link da imagem para incluir na mensagem do fórum.

Uma sugestão de serviço gratuito para publicar imagens é o imgur.com ou o próprio GitHub, além de serviços de armazenamento em nuvem.

Terceiro passo: elaborar a mensagem

Como escrever o que está acontecendo?

• utilizar tom cordial, com saudação inicial e pedido de ajuda no final
• formatação Markdown melhora a comunicação
• mensagem com o máximo de informação possível
• 3 seções fundamentais da mensagem:
  • breve descrição do problema;
  • cópia do trecho do código que está dando erro (em formato de código)
  • cópia do erro exibido no console do navegador
    • texto ou imagem (o que for melhor para a compreensão)

E se a mensagem ficar muito longa?

A maioria dos fóruns de discussão limitam a quantidade de caracteres da mensagem.
O ideal é manter o texto dentro deste limite, mas nem sempre é possível.
Nesses casos, assim como foi feito com a imagem, uma alternativa seria utilizar um serviço externo para publicar a mensagem e gerar um link de acesso. Por exemplo, o Gist do GitHub (gist.github.com) ou o próprio GoogleDocs.
O Gist tem a vantagem de formatar o código com aparência semelhante às IDEs, além de permitir adicionar mais de um arquivo de texto na mesma publicação, melhorando a organização da mensagem.

Exemplo de mensagem:

---

Olá, tudo bem?
Não estou conseguindo validar o CPF.
Quando abro a aplicação no navegador aparece um erro no console, mas não sei o que é.
Já revisei e o erro continua.

O meu código está desta maneira:

function validaCPF(input){
  const cpfFormatado = input.value.replace(/\D/g, '');
  let mensagem ='';

  if(!checaCPFRepetido(cpfFormatado)) {
    mensagem = 'o CPF digitado não é válido.';
  }

  input.setCustomValidit(mensagem);
}

e no console do navegador aparece esta mensagem de erro:

 Uncaught TypeError: input.setCustomValidit is not a function  |  validacao.js:110:9
   validaCPF file:///home/valida-cpf/js/validacao.js:110
   cpf file:///home/valida-cpf/js/validacao.js:55
   valida file:///home/valida-cpf/js/validacao.js:7
   <anonymous> file:///home/valida-cpf/js/validacao.js:142

Se puderem me ajudar, agradeço!
Já comparei com o que o professor passou em aula e parece igual, refiz este trecho do código, mas o erro permanece! 😕

Onde está o bug ???
Help me!!!

---

Quarto passo: revisar a mensagem antes de enviar

Quase sempre pulamos esta etapa… aí, já viu!

• É uma etapa importante
• Assegura a melhor compreensão da mensagem
• Reduz a necessidade de edição (quase inevitável)
• Correções e ajustes feitos…
• Estando tudo OK, enviar!

---

Referência sobre formatação Markdown

Uma rápida busca na internet sobre ‘markdown editor online’ retornará uma lista considerável de opções.

• Testei alguns e achei o stackedit.io bem interessante. Utilizei para produzir este material e minha avaliação até agora é muito positiva.
• É uma aplicação web open source. Possui interface intuitiva e oferece uma série de recursos gratuitos, na verdade, apenas as opções de exportação como PDF, ePub, Doc são exclusivas para apoiadores pagantes, tudo mais o acesso é livre.
• Algumas funcionalidades disponíveis na plataforma que fazem a diferença:

• acesso gratuito
• exemplos de códigos de marcação
• editor WYSIWYG
• botoneira de comandos (com undo / redo)
• importar e exportar HTML / MD
• exportar PDF / ePub / Doc (exclusivo para apoiadores)
• login com conta Google / GitHub
• auto save (nuvem / Drive)
• trabalha offline
• histórico de trabalho
• espaço colaborativo
• configurações
• metadados
• templates
• badges

---

Referência sobre emojis no Markdow

Encontrei lista de códigos de emojis neste repositório:
👉 github.com/ikatyang/emoji-cheat-sheet

---

se gostou deste material, compartilhe! 😉 🙏
material com livre reprodução, obrigando-se citar a fonte:
https://netopaiva.github.io/devweb.help/postagens/reportar-erros.html
© netopaiva – última atualização: 18/julho/2023 - 22h .

---