Introdução
Este guia demonstra como usar GitHub Issues 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. Os membros de uma empresa com usuários gerenciados só podem fazer alterações nos repositórios que fazem parte de suas empresas. O repositório deve ter problemas habilitados. Para saber mais sobre como criar um repositório, confira Criar um repositório. Para obter mais informações sobre como habilitar os problemas se eles estiverem desabilitados no seu repositório, confira 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 maneiras de criar um problema, confira Criar um problema.
-
Em GitHub, acesse a página principal do repositório.
-
No nome do seu repositório, clique em Problemas.
-
Clique em Novo problema.
-
Neste exemplo, começaremos com um problema em branco. Seu repositório poderá usar modelos de problemas e formulários de problemas para incentivar os colaboradores a fornecer informações específicas. Se o repositório usar modelos de problema, clique em Abrir um 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 saber mais, confira Como escrever no GitHub.
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 acrescentando [ ] antes dos itens de lista. 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 saber mais, confira Sobre listas de tarefas.
Adicionando etiquetas
Adicione uma etiqueta para categorizar o seu problema. Por exemplo, você pode usar um rótulo bug e um rótulo good first issue para indicar que um problema é um bug que um colaborador que está contribuindo pela primeira vez pode detectar. 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 saber mais, confira Gerenciar 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 saber mais, confira Sobre marcos.
Atribuindo o problema
Para comunicar-se responsabilidade, você pode atribuir o problema a um integrante da sua organização. Para saber mais, confira Atribuir problemas e pull requests a outros usuários do GitHub.
Adicionando a problema a um projeto
Você pode adicionar o problema a um projeto existente e preencher metadados para o projeto. Para obter mais informações sobre projetos, confira Sobre Projects.
Enviando o seu problema
Clique em Enviar novo problema para criar 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 @mention colaboradores ou equipes para chamar a atenção deles para um comentário. Para vincular problemas relacionados no mesmo repositório, digite # seguido de uma parte do título do problema e clique no problema que deseja vincular. Para saber mais, confira Como escrever no GitHub.
Próximas etapas
Você pode usar problemas para uma grande variedade de finalidades. Por exemplo:
- Rastrear ideias
- Coletar feedback
- Planejar tarefas
- Como relatar bugs
Para dividir seu problema em tarefas mais gerenciáveis, você pode adicionar vários níveis de subproblemas. Confira Como adicionar subproblemas.
Veja alguns recursos úteis para dar seus próximos passos com o GitHub Issues:
- Para saber mais sobre os problemas, confira Sobre issues.
- Para saber mais sobre como os projetos podem ajudar você com o planejamento e o acompanhamento, confira Sobre Projects.
- Para saber mais sobre como usar modelos de problemas e formulários de problemas para incentivar os colaboradores a fornecer informações específicas, confira Usando modelos para incentivar problemas úteis e receber pull request.