Pular para o conteúdo principal

Como Documentar Problemas no GitHub para o CodeGPT

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

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

Etapas para Documentar um Problema

  1. Verifique Problemas Existentes

    • Antes de criar um novo problema, verifique os problemas existentes para garantir que seu problema não tenha sido relatado anteriormente.
  2. Abra um Novo Problema

    • Navegue até a guia Aba de Problemas do repositório CodeGPT.
    • Clique no botão Novo problema.
  3. Selecione o Tipo de Problema

    • Escolha o modelo de problema apropriado que melhor descreve seu problema:
      • Relatório de BUG
      • Solicitação de Recurso
      • Melhoria de Documentação
      • Outro
  4. Preencha o Modelo de Problema

    • Título: Forneça um título claro e conciso para 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: Adicione capturas de tela se aplicável.
    • Ambiente: Inclua informações relevantes sobre o ambiente em que o problema ocorreu:
      • SO (por exemplo, Windows, macOS, Linux)
      • Navegador (se aplicável)
      • Versão do CodeGPT
      • Qualquer outro detalhe relevante
  5. Informações Adicionais

    • Logs: Forneça quaisquer mensagens de log ou códigos de erro relevantes.
    • Soluções Alternativas: Mencione se você encontrou quaisquer soluções alternativas.
    • Referências: Link para quaisquer problemas ou discussões relacionados.
  6. Envie o Problema

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

Modelo de Problema de Exemplo

Aqui está um exemplo de um problema bem documentado:

Relatório de BUG

Título: O CodeGPT trava ao abrir arquivos grandes

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

Passos para Reproduzir:

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

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

Comportamento Real: O CodeGPT trava com uma mensagem de erro dizendo, "O 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: Sem soluções alternativas conhecidas.

Referências: Problema relacionado: #123

Dicas para Relatar Problemas Eficazmente

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

Ao seguir essas diretrizes, você nos ajudará a melhorar o CodeGPT para todos. Obrigado pela sua contribuição!