Ao escrever um relatório de erro, por favor inclua um título breve e relevante.
O título deve dizer qual o comportamento * esperado * deve ser *. Embora seja útil descrever o que está quebrado, esta abordagem está repleta de dois perigos. Primeiro, por favor inclua informações suficientes e não apenas "a mesa está quebrada". Em segundo lugar, por favor, diga qual é o comportamento correto esperado, em vez do que está quebrado. Por exemplo, se você disser "a mesa não deve classificar por data" então o engenheiro que vai corrigi-la terá que gastar esforço extra descobrindo como deve se comportar: deve classificar por nome, ascendendo? Deve classificar por id, descendo? Mesmo quando um erro é claramente óbvio, a correção certa geralmente tem que ser descrita independentemente do problema. Assim, é melhor usar o título para descrever de forma breve e relevante que a funcionalidade *deve ser*, em vez de como exatamente é quebrado.
Importante, cada relatório de bug deve ter três partes: passos para reproduzir, resultado esperado, resultado real.
Passos para reproduzir:
Por exemplo:
* login de um usuário padrão
* abrir SearchModal, escreva "any" no campo de nome, clique em "run"
* abrir ConsultasModal, clique para modificar uma consulta
* clique em "salvar" para terminar de modificar
# # # # Resultado esperado:
Por exemplo:
os resultados devem estar vazios e o título dos resultados deve dizer "sem resultados"
Resultado real:
Por exemplo:
A tabela de resultados está inalterada e ainda mostra algum número de resultados da pesquisa anterior.
Note-se que nem todas as informações acima são realmente relevantes e necessárias para cada relatório de bug, mas é realmente útil pensar nessas três peças como necessário. A falta de informação conduzirá inevitavelmente a mais perguntas dos engenheiros - por isso poupa tempo a todos para adicionar essa informação desde o início.
Importante, nas capturas de tela, incluir o URL de cada página, em cada captura de tela. O url é muitas vezes muito, muito importante e apenas ter uma captura de tela da página, sem o url, muitas vezes não fornece informações suficientes para corrigir um problema.
