Início rápido para problemas no GitHub

Siga este breve guia interativo para aprender mais sobre Problemas do GitHub.

Introdução

Este guia demonstra como usar Problemas do GitHub para planejar e rastrear um trabalho. Neste guia, você irá criar um novo problema e adicionar uma lista de tarefas para acompanhar as subtarefas. Você também aprenderá como adicionar etiquetas, marcos, responsáveis e projetos para comunicar metadados sobre o seu problema.

Pré-requisitos

Para criar um problema, você precisa de um repositório. Você pode usar um repositório existente ao qual você tem acesso de gravação ou criar um novo repositório. O repositório deve ter problemas habilitados. Para obter mais informações sobre como criar um repositório, consulte "Criar um repositório". Para obter mais informações sobre problemas de habilitação se eles estiverem desabilitados no seu repositório, consulte "Desabilitar problemas".

Abrir um problema em branco

Primeiro, crie um problema. Existem várias maneiras de criar um problema. Você pode escolher o método mais conveniente para seu fluxo de trabalho. Este exemplo usará a interface do usuário de GitHub Para obter mais informações sobre outras formas de criar um problema, consulte "Criar um problema".

  1. No GitHub.com, navegue até a página principal do repositório.
  2. Abaixo do nome do seu repositório, clique em Problemas. Aba de problemas
  3. Clique em New issue (Novo problema). Botão New Issues (Novos problemas)
  4. Neste exemplo, começaremos com um problema em branco. Seu repositório pode usar os modelos de problema e formulários de problema para incentivar os colaboradores a fornecer informações específicas. Se seu repositório usa modelos de problema, clique em Abrir um problema em branco.

problema em branco

Preenchimento de informações

Dê um título descritivo ao seu problema. O título deverá transmitir resumidamente o problema.

Adicione uma descrição que explique o propósito do problema, incluindo todos os detalhes que possam ajudar a resolvê-lo. Por exemplo, se este for um relatório de erro, descreva as etapas para reproduzir o erro, o resultado esperado e o resultado real.

Você pode usar o markdown para adicionar formatação, links, emojis e muito mais. Para obter mais informações, consulte "Escrevendo no GitHub".

título e texto do problema

Adicionando uma lista de tarefas

Pode ser útil dividir problemas grandes em tarefas menores, ou rastrear vários problemas relacionados em um problema único maior. Adicione uma lista de tarefas ao seu problema, fornecendo uma breve introdução com [ ]. Referência de problemas existentes por número de problema ou URL. Você pode usar texto simples para acompanhar as tarefas que não têm um problema correspondente e convertê-las em problemas posteriormente. Para obter mais informações, consulte "Sobre listas de tarefas".

problema com lista de tarefas

Adicionando etiquetas

Adicione uma etiqueta para categorizar o seu problema. Por exemplo, você pode usar uma etiqueta de bug e uma etiqueta good first issue para indicar que um problema é um bug que um primeiro colaborador poderia selecionar. Os usuários podem filtrar problemas por etiqueta para encontrar todos os problemas com uma etiqueta específica.

Você pode usar as etiquetas padrão ou criar uma nova. Para obter mais informações, consulte "Gerenciar etiquetas".

problema com etiquetas

Adicionar marcos

Você pode adicionar um marco para acompanhar o problema como parte de um destino baseado em data. Um marco mostrará o progresso dos problemas à medida que se aproxima o prazo. Para obter mais informações, consulte "Sobre marcos".

problema com marco

Atribuindo o problema

Para comunicar-se responsabilidade, você pode atribuir o problema a um integrante da sua organização. Para obter mais informações, consulte "Atribuir problemas e pull requests a outros usuários do GitHub".

problema com responsáveis

Adicionando a problema a um projeto

Você pode adicionar um problema a um projeto existente. Se você usar projetos (beta), você também poderá preencher os metadados do projeto. Para mais informações sobre projetos, consulte "Sobre projetos (beta)e "Organizar o seu trabalho com quadros de projeto".

problema com projetos

Enviando o seu problema

Clique em Enviar novo problema para criar o seu problema. Você pode editar qualquer um dos campos acima após a criação do problema. Seu problema tem uma URL única que você pode compartilhar com os integrantes da equipe ou fazer referência a outros problemas ou pull requests.

Comunicar

Depois que o seu problema for criado, continue a conversa adicionando comentários ao problema. Você pode @mencionar colaboradores ou equipes para chamar a atenção para um comentário. Para vincular problemas relacionados no mesmo repositório, você pode digitar # seguido de parte do título do problema e, em seguida, clicar no problema que você deseja vincular. Para obter mais informações, consulte "Escrevendo no GitHub".

issue comment

Próximas etapas

Você pode usar problemas para uma grande variedade de finalidades. Por exemplo:

  • Rastrear ideias
  • Coletar feedback
  • Planejar tarefas
  • Relatar erros

Aqui estão alguns recursos úteis para dar seus próximos passos com Problemas do GitHub:

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.