Pular para o conteúdo principal

Como Documentar Problemas no GitHub para o CodeGPT

Por favor, siga estas diretrizes ao criar um novo problema no repositório CodeGPT para garantir que os problemas sejam comunicados e resolvidos de forma eficaz.

⚠️ Aviso: Problemas que não seguirem estas diretrizes podem não ser considerados.⚠️

Passos para Documentar um Problema​

  1. Verifique Problemas Existentes

    • Antes de criar um novo problema, verifique os problemas existentes para garantir que seu problema ainda não foi relatado.

  2. Abra um Novo Problema

    • Navegue até a aba de Problemas do repositório CodeGPT.
    • Clique no botão New issue.

  3. Selecione o Tipo de Problema

    • Escolha o modelo de problema apropriado que melhor descreve seu problema:
      • Relatório de Bug
      • Solicitação de Funcionalidade
      • Melhoria de Documentação
      • Outro

  4. Preencha o Modelo de Problema

    • Título: Forneça um título claro e conciso para o seu problema.
    • Descrição: Descreva o problema em detalhes, incluindo:
      • Passos para Reproduzir: Forneça uma descrição passo a passo de como reproduzir o problema.
      • Comportamento Esperado: Descreva o que você esperava que acontecesse.
      • Comportamento Real: Descreva o que realmente aconteceu.
      • Capturas de Tela: Anexe capturas de tela, se aplicável.
    • Ambiente: Inclua informações relevantes sobre o ambiente onde o problema ocorreu:
      • SO (por exemplo, Windows, macOS, Linux)
      • Navegador (se aplicável)
      • Versão do CodeGPT
      • Quaisquer outros detalhes relevantes

  5. Informações Adicionais

    • Logs: Forneça quaisquer mensagens de log ou códigos de erro relevantes.
    • Soluções Alternativas: Mencione se você encontrou alguma solução alternativa.
    • Referências: Link para quaisquer problemas ou discussões relacionadas.

  6. Envie o Problema

    • Revise seu problema para garantir que todas as informações necessárias estejam incluídas.
    • Clique no botão Submit new issue.

Exemplo de Modelo de Problema​

Aqui está um exemplo de um problema bem documentado:

Relatório de Bug​

Título: CodeGPT trava ao abrir arquivos grandes

Descrição: Quando tento abrir um arquivo grande (mais de 20MB) no CodeGPT, o aplicativo trava imediatamente.

Passos para Reproduzir:

  1. Abra o CodeGPT.
  2. Vá para Arquivo > Abrir.
  3. Selecione um arquivo maior que 20MB.
  4. Clique em Abrir.

Comportamento Esperado: O CodeGPT deve abrir o arquivo grande sem travar.

Comportamento Real: O CodeGPT trava com uma mensagem de erro dizendo, "Aplicativo parou de funcionar."

Capturas de Tela: Captura de Tela do Erro

Ambiente:

  • SO: Windows 10
  • Versão do CodeGPT: 1.2.3
  • Memória: 16GB
  • Processador: Intel i7

Logs:

Soluções Alternativas: Nenhuma solução alternativa conhecida.

Referências: Problema relacionado: #123

Dicas para Relatar Problemas de Forma Eficaz​

  • Seja Específico: Forneça o máximo de detalhes possível para nos ajudar a entender e reproduzir o problema.
  • Mantenha o Foco: Concentre-se em um único problema por relatório. Se você tiver vários problemas, crie relatórios separados para cada um.
  • Acompanhe: Se mais informações se tornarem disponíveis, atualize o problema com novos detalhes.

Seguindo estas diretrizes, você nos ajuda a melhorar o CodeGPT para todos. Obrigado pela sua contribuição!