Skip to content

Como abrir uma issue

Antes de criar uma issue

Antes de abrir uma nova issue, siga as práticas à seguir:

  1. Pesquise se o problema já foi relatado antes. Utilize a busca na página de issues do projeto EasyCrit. Use as labels para filtrar a sua pesquisa e facilitar a busca.
  2. Verifique os templates de issues disponíveis. Existem modelos específicos para bugs, sugestões e perguntas.

Como abrir uma issue

  1. Acesse o repositório de documentação do projeto EasyCrit.
  2. Clique na aba Issues
  3. Clique em New issue
  4. Escolha o template adequado
    • 🪲 Bug para relatar falhas no funcionamento
    • 💡 Sugestão para sugerir novas funcionalidade ou uma mudança em uma funcionalidade existente
    • Pergunta para tirar alguma dúvida e/ou pedir orientação
  5. Preencha todas as seções do template com o máximo de detalhe possível:
    • Título objetivo e descritivo
    • Descrição clara do problema ou suestão
    • Passo a passo detalhado (em caso de bug)
    • Ambiente (seu sistema operacional, versão das ferramentas, dependências, etc...)

Dicas finais

Lembre de ser claro e objetivo, ser respeitoso com a comunidade e seus mantenedores e de marcar a issue como fechada quando ela for resolvida, se aplicável.

Lembre-se também de sempre que possível anexar capturas de tela, trechos de código ou logs que ajudem na compreensão do problema.


Abrir uma issue é mais que apenas apontar um problema, é poder participar ativamento no desenvolvimento do projeto.