unitedcodelab / plataforma-cursos

0 stars 0 forks source link

Como reportar uma issue #15

Open antonionetu opened 4 months ago

antonionetu commented 4 months ago

Guia para Reportar Issues

Ao reportar uma issue em um repositório, é importante fornecer informações claras e detalhadas para ajudar os mantenedores a entenderem e resolverem o problema de forma eficiente. Passos para Reportar uma Issue

  1. Verifique se a issue já foi reportada: Antes de criar uma nova issue, verifique se o problema já foi relatado anteriormente. Isso pode ser feito pesquisando nas issues existentes ou na seção de "Problemas fechados".

  2. Criando uma nova issue:

    • Clique no botão "Issues" no repositório.
    • Em seguida, clique no botão verde "New issue" para começar a criar uma nova issue.
  3. Nos forneça as informações necessarias: Ao criar uma nova issue, você será apresentado a um formulário com campos importantes. Aqui estão os principais detalhes que devem ser incluídos:

    • Título descritivo: Um resumo conciso do problema.
    • Descrição detalhada: Explique o problema em detalhes. Inclua passos reproduzíveis, se possível.
    • Ambiente: Especifique o ambiente em que o problema ocorre (por exemplo, sistema operacional, versão do software, navegador).
    • Comportamento esperado e observado: Descreva o que você esperava que acontecesse e o que realmente aconteceu.
    • Capturas de tela: Anexe capturas de tela, se aplicável, para ilustrar o problema.
    • Logs e mensagens de erro: Inclua qualquer mensagem de erro relevante ou logs que possam ajudar na investigação.
  4. Revisão antes de enviar: Antes de enviar a issue, revise todas as informações para garantir que estejam claras e completas.

Template de issue:

Veja aqui um exemplo de .md para reportar issues !

Muito obrigado por nos ajudar a fazer aqui um lugar melhor :)