Na hora de reportar um bug, a primeira coisa a se fazer é o resumo.
Descreva o erro usando aproximadamente 10 palavras.
Um bom resumo deve colaborar para que quem o leia, identifique o erro rápido. No relatório, o que deve ser relatado deve ser exclusivamente o problema, evitando sugerir possíveis soluções neste passo.
Exemplos:
Bom: "Ao cadastrar usuário, sistema não redireciona para login." Ruim: "Programa trava." Em seguida, é necessário descrever passos precisos para reproduzir esse erro.
Como alguém poderia reproduzir o erro por conta própria em sua máquina?
Descreva a interação com o sistema, de maneira clara.
Exemplos:
Impreciso: "Abra o sistema."
Preciso: "Pressione Cmd+N para abrir uma nova janela no navegador. Em seguida, digite https://alurapic.com.br/ na barra de endereço e tecle Enter."
Impreciso: "Preencha o Cadastro."
Preciso: "Na tela de cadastro, digite usuário, e-mail, senha, confirme a senha e clique em Cadastrar.”
Impreciso: "Não funciona."
Preciso: Ao Clicar em Cadastrar, o sistema permanece estático, não dá feedback ao usuário e permanece na tela de Cadastro."
Depois dos passos claros e bem definidos, precisamos preencher outras informações que podem dar mais clareza aos desenvolvedores.
Exemplo:
Versão: Qual versão do produto você está testando?
No canto no sistema, você pode observar o número da versão, a 3.7.
Plataforma: Mencione a plataforma de hardware em que foi encontrado o bug. São várias as plataformas como “PC”, “MAC”, “IOS”, “Android” e etc.
Navegador: Qual browser você usou para testar. No meu caso, usei o Google Chrome.
E por fim, você ainda pode colocar um screenshot da tela com o código de erro que possa aparecer.