Skip to content

Repositório de Documentação de Erros Este projeto foi um estudo de viabilidade para usar o GitHub como ferramenta de registro e acompanhamento de erros por meio de Issues, aproveitando seus recursos de busca e filtragem. A experiência demonstrou eficiência na organização de problemas e soluções, e hoje essa metodologia é aplicada na Adapti.

Notifications You must be signed in to change notification settings

Alberttavares/errors

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

📚 Repositório de Documentação de Erros

Bem-vindo ao repositório de erros! Este repositório foi criado para documentar os problemas encontrados durante o desenvolvimento e as soluções aplicadas. Aqui você pode encontrar erros já registrados ou reportar um novo erro.


🔍 Como Encontrar um Erro?

  1. Acesse a Aba de Issues:

    • No topo do repositório, clique em Issues.
  2. Busque pelo Erro:

    • Use a barra de busca para procurar palavras-chave relacionadas ao erro.
    • Filtre os resultados utilizando as etiquetas disponíveis (ex.: frontend, backend, infraestrutura, etc.).
  3. Leia a Documentação:

    • Clique em uma Issue para ver os detalhes, contexto e possíveis soluções.

Filtragem de Issues

Você pode usar diferentes filtros de busca para encontrar a Issue que procura:

🔑 Buscar por Título

Se você quer buscar por uma palavra ou frase específica no título de uma issue, use o filtro in:title. Exemplo:

in:title "erro de login"

Isso encontrará todas as issues cujo título contenha "erro de login".

🏷️ Buscar por Etiquetas (Tags)

Você pode buscar issues por etiquetas específicas. Para isso, use o filtro label:<nome-da-etiqueta>. Exemplo:

label:frontend

Isso encontrará todas as issues com a etiqueta frontend.

🔑🏷️ Buscar por Título e Etiqueta

Se você deseja buscar por um termo no título e por uma etiqueta específica, combine ambos os filtros. Exemplo:

in:title "login" label:frontend

Isso encontrará issues que tenham "login" no título e que sejam marcadas com a etiqueta frontend.


📝 Como Reportar um Novo Erro?

  1. Acesse a Aba de Issues:

    • Clique em Issues no menu superior do repositório.
  2. Clique em "New Issue":

    • No canto direito, clique no botão verde "New Issue".
  3. Escolha o Template de Erro:

    • Caso exista um template configurado, selecione o modelo de registro de erro.
  4. Preencha as Informações:

    • Adicione um título claro e objetivo para o erro.
    • Inclua uma descrição detalhada no corpo da Issue:
      • Contexto: Onde e como o erro ocorreu.
      • Detalhes do Erro: Logs, mensagens de erro, capturas de tela ou código relevante.
      • Solução (opcional): Se você encontrou uma solução, descreva-a.
  5. Adicione Etiquetas:

    • Selecione etiquetas relevantes (ex.: bug, frontend, backend).
  6. Envie o Relatório:

    • Clique em Submit new issue para registrar o erro.

🛠️ Boas Práticas para Relatar Erros

  • Seja claro e objetivo no título.
  • Adicione o máximo de informações possíveis no corpo do relatório.
  • Use as etiquetas adequadas para facilitar a busca e organização.

📂 Como Acessar a Documentação no Futuro?

  • Este repositório é uma base de conhecimento que pode ser consultada a qualquer momento.
  • Volte à aba de Issues para buscar problemas semelhantes antes de tentar resolver sozinho.
  • Use a barra de busca para encontrar rapidamente erros relacionados.

Se tiver dúvidas ou sugestões, entre em contato com o diretor, gerente de projetos ou o gerente de processos internos.

About

Repositório de Documentação de Erros Este projeto foi um estudo de viabilidade para usar o GitHub como ferramenta de registro e acompanhamento de erros por meio de Issues, aproveitando seus recursos de busca e filtragem. A experiência demonstrou eficiência na organização de problemas e soluções, e hoje essa metodologia é aplicada na Adapti.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published