Bug report - ifspcodelab/gestao-estagios-backend GitHub Wiki
Índice
O que fazer antes de criar um bug report?
O que deve conter em um bug report?
Como criar uma issue no github?
O que fazer antes de criar um bug report?
- Reproduzir o bug no mínimo 3 vezes antes de criar uma issue
- Verificar o ambiente de desenvolvimento e serviços terceirizados utilizados pela plataforma
- Verificar se o problema já foi registrado
O que deve conter em um bug report?
Título
Deve ser curto e específico.
Exemplo: CARRINHO - Novos itens adicionados ao carrinho não aparecem.
Mostra onde o problema ocorre: CARRINHO
Mostra de forma simplificada o bug: Novos itens adicionados ao carrinho não aparecem.
Descrição
Um texto curto e objetivo com informações pertinentes, incluindo onde e como o bug ocorreu, além de keywords para facilitar a busca da issue.
Evite ser repetitivo.
Passos para reprodução
Uma lista ordenada com os passos para a reprodução do bug:
- Passo 1;
- Passo 2;
- Passo 3.
Resultado esperado X Resultado obtido
É importante adicionar qual o resultado esperado e qual foi o resultado obtido durante o passo a passo. Assim é possível saber como o software se comporta e como ele se comportaria caso este bug não existisse.
Evidências
Imagens e gravações de tela que comprovam a existência do bug. Auxiliam o desenvolvedor a compreender de maneira rápida e fácil o problema.
Podem ser utilizadas como evidências:
- Prints de tela;
- Gravações de tela;
- Prints do console;
- Prints do Postman ou Insomnia;
- Logs;
- Path onde ocorre o problema.
Informações adicionais
São informações que podem auxiliar na identificação do bug:
- Sistema Operacional (Ex: Windows 10 Home)
- Versão browser (Ex: google chrome: Versão 113.0.5672.93 (Versão oficial) 64 bits)
- Ambiente (Ex: teste, produção, etc)
- Versão da aplicação (Ex: v1)
- Versão {nome IDE - modelo} (Ex: Intellij Ultimate: 2022.5)
- Versão {programa} (Ex: Postman for Windows: 10.13.5)
- Outras informações que forem pertinentes
Prioridade e Severidade
-
A prioridade mostra para o desenvolvedor qual bug deve ser resolvido primeiro.
Alta: deve ser resolvido o mais rápido possível
Média: deve ser resolvido após todos os bugs com prioridade alta serem resolvidos
Baixa: precisa ser corrigido, porém pode ser resolvido depois
-
A severidade mostra o impacto que o bug causa na aplicação, podendo ser:
Alta: afeta o funcionamento do sistema, impossibilitando o seu uso
Média: afeta o funcionamento do sistema, mas o usuário consegue contornar a situação
Baixa: não afeta o funcionamento do sistema
Justificativa de prioridade e severidade
Informações opcionais que justificam a prioridade e severidade do bug.
Assignees e labels
Assignees são os membros da equipe que serão responsáveis pela issue.
Labels é o tipo de issue. (Ex: bug, refactor, enhancement).
Como criar uma issue no github?
- Dentro do repositório, selecione a opção issues
- Clique em "New issue"
- Clique em "Get started"
- Após preencher todas as informações necessárias, clique em "Submit new issue"