O que é exemplo reproduzível
Exemplo reproduzível é o menor caso que outra instalação consegue executar para observar a mesma falha. Ele reúne a entrada e os passos até a falha. Também registra a versão, a configuração e a diferença entre o resultado esperado e o observado.
O exemplo é uma reprodução delimitada do problema, e não um resumo do projeto. Ele carrega o necessário para repetir o comportamento e comparar o retorno. Quando funciona como descrito, o mantenedor investiga sem adivinhar o que aconteceu.
O que o relato precisa conter
Informe o valor enviado, os passos até a falha e o retorno recebido. Acrescente a versão da biblioteca ou do sistema, o ambiente e a configuração que interfere no comportamento. Diga também o que você esperava e de onde vem essa expectativa: documentação, teste existente ou versão anterior.
Uma issue útil separa o observado da suspeita. A suspeita pode orientar a investigação, mas não deve aparecer como causa confirmada. O mesmo vale para uma sugestão produzida por IA.
Reduzir sem apagar a falha
Um projeto completo pode ter configurações que escondem a causa. Retire o que não participa do erro, uma parte por vez, e execute o caso depois de cada remoção. Quando a falha desaparecer, você encontrou uma condição relevante e precisa reintroduzi-la.
No exemplo abaixo, a configuração de idioma determina o formato aceito. Removê-la simplifica o caso e muda o resultado, o que já não reproduz a falha original.
O que o exemplo não prova
Uma execução correta demonstra o comportamento daquele caso. Ela não cobre outros caminhos, outras versões ou condições de volume. Por isso o exemplo acompanha o teste unitário e a regressão, sem substituir a leitura do código.
O log da aplicação pode complementar o relato quando mostra a configuração aplicada ou o erro recebido. Remova credenciais e informações pessoais antes de compartilhar.
Conferir antes de enviar
Execute o exemplo em um ambiente limpo, com a versão informada, e compare o retorno com o texto do relato. Se um colega repetir o caso, o exemplo está pronto para seguir em uma pull request ou em uma issue.
Para investigar uma falha do projeto com orientação ao vivo, o Desenvolvimento Colaborativo da Dev Side Studio permite executar o caso e examinar o retorno durante a sessão.
Dúvidas frequentes
Perguntas frequentes sobre Exemplo reproduzível
- Preciso enviar o projeto inteiro?
- Não. O envio completo dificulta a investigação. Reduza para o menor conjunto que ainda produz a falha, mantendo a configuração e a versão que participam do comportamento.
- Posso colar apenas a mensagem de erro?
- A mensagem sozinha não mostra a entrada nem a configuração. O relato precisa permitir que outra instalação execute o mesmo caso e compare o retorno.
- O agente pode montar o exemplo?
- Pode ajudar a reduzir o caso e a redigir os passos. Você ainda precisa executar o exemplo e conferir se o relato corresponde ao comportamento observado.
- E se a falha não se repetir no caso reduzido?
- Então o caso perdeu a condição que produzia o erro. Reintroduza a configuração removida e teste de novo antes de enviar o relato.
Para continuar
Recursos relacionados
Site de referência
Stack Overflow: como criar um exemplo mínimo e reproduzível
Orienta a reduzir o caso, informar a versão e descrever o resultado esperado.
Abrir recursoDocumentação
GitHub Docs: criar uma issue
Mostra onde registrar o relato e os campos que acompanham a descrição.
Abrir recursoAplicação na formação
Vibe Coding: Do Zero ao MVP
O exemplo reproduzível permite conferir uma falha e orientar o agente com um caso executável.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.