GitHub é uma plataforma colaborativa

Concluído

A colaboração está no centro de tudo o que o GitHub faz. Analisamos os repositórios na primeira unidade do módulo e aprendemos que os repositórios ajudam você a organizar seu projeto e seus arquivos. Na última unidade, aprendemos sobre solicitações pull, que é uma maneira de acompanhar as alterações feitas no seu projeto.

Nesta unidade, estamos aprendendo sobre questões e discussões. Esses são recursos que contribuem para a natureza colaborativa da Plataforma Empresarial GitHub.

Problemas

Os GitHub Issues são utilizados para acompanhar ideias, feedback, tarefas ou bugs relacionados com o trabalho no GitHub. Os problemas podem ser criados de várias maneiras, para que você possa escolher o método mais conveniente para seu fluxo de trabalho.

Este passo a passo aborda como criar um problema a partir de um repositório. Os problemas também podem ser criados a partir de:

  • Um item em uma lista de tarefas.
  • Uma nota num projeto.
  • Um comentário num incidente ou num pedido de pull.
  • Uma linha de código específica.
  • Uma consulta de URL.

Criando um problema a partir de um repositório

  1. No GitHub.com, navegue até a página principal do repositório.

  2. Sob o nome do repositório, selecione Problemas.

    Captura de tela mostrando a parte superior da página principal de um repositório com a seção Problemas realçada.

  3. Selecione Novo problema. Isto deve abrir um campo de problema em branco para preencheres.

  4. Se o seu repositório utilizar modelos de incidências, deverá ver uma lista dos tipos de incidência, a partir da qual poderá selecionar o que pretende utilizar.

    Se o tipo de problema que quiser abrir não estiver incluído nas opções disponíveis, selecione Problema em branco. Se não estiver usando modelos, pule para a Etapa 5.

    Se o repositório usar formulários de problema, você verá um formulário estruturado para preencher em vez de um modelo de problema em branco. Os formulários de emissão permitem que os mantenedores coletem informações específicas em um formato padronizado.

    Uma captura de ecrã do menu de modelos de questões, com a opção Abrir uma questão em branco destacada.

  5. No campo Adicionar um título , insira um título para o seu problema.

  6. No campo Adicionar uma descrição , digite uma descrição do problema.

  7. Se você for um mantenedor de projeto, poderá atribuir o problema a alguém, adicioná-lo a um quadro do projeto, associá-lo a uma etapa ou aplicar um rótulo.

  8. Quando terminar, selecione Enviar novo problema.

Use rótulos, menções e reações para gerenciar a colaboração de forma eficaz e aumentar a visibilidade do problema. Os modelos de problemas ajudam a manter uma estrutura e expectativas consistentes para os contribuidores.

Algumas conversas podem ser mais apropriadas para discussões no GitHub. Use as Discussões do GitHub para fazer e responder perguntas, compartilhar informações, fazer anúncios e conduzir ou participar de conversas sobre um projeto.

Na próxima seção, analisaremos Discussões e como utilizar melhor o recurso.

Discussões

As discussões são projetadas para conversas que não estão necessariamente vinculadas ao código, como perguntas e respostas, ideias ou feedback geral. Eles suportam comunicação aberta e contínua dentro de um fórum compartilhado e podem ser públicos ou privados, dependendo da visibilidade do repositório.

Nesta secção, irá aprender a:

  • Habilitando uma discussão em seu repositório.
  • Criação de uma nova discussão e várias categorias de discussão.

Vamos ver como ativar uma discussão no seu repositório.

Ativando uma discussão em seu repositório

Os proprietários de repositórios e aqueles com acesso de gravação podem habilitar as discussões do GitHub para uma comunidade em seus repositórios públicos e privados. A visibilidade de uma discussão herda a visibilidade do repositório em que ela foi criada.

Ao ativar as Discussões do GitHub pela primeira vez, você será solicitado a configurar uma postagem de boas-vindas.

  1. No GitHub.com, navegue até a página principal do repositório.

  2. Sob o nome do repositório, selecione Configurações.

    Uma captura de tela da parte superior da página principal de um repositório com a seção Configurações realçada.

  3. Role para baixo até a seção Recursos e, em Discussões, selecione Configurar discussões.

    Uma captura de ecrã da caixa Discussões com o botão verde Configurar discussão realçado.

  4. Em Iniciar uma nova discussão, edite o modelo para corresponder ao tom e aos recursos da sua comunidade.

  5. Selecione Iniciar discussão.

Agora você está pronto para criar uma nova discussão.

Criar uma nova discussão

Qualquer usuário autenticado que possa visualizar o repositório pode criar uma discussão nesse repositório. Para discussões no nível da organização, qualquer usuário que possa visualizar o repositório de origem também pode criar uma discussão.

  1. No GitHub.com, navegue até a página principal do repositório ou da organização onde deseja iniciar uma discussão.

  2. Sob o nome do repositório ou da organização, selecione Discussões.

    Uma captura de tela da parte superior da página principal de um repositório com a seção Discussões realçada.

  3. No lado direito da página, selecione Nova discussão.

  4. Selecione uma categoria de discussão escolhendo Introdução. Todas as discussões devem ser colocadas em uma categoria. Os mantenedores do repositório definem essas categorias.

    Uma captura de ecrã do menu de seleção de categoria de discussão, com a opção do topo Anúncios e o botão Começar realçados.

Cada categoria de discussão inclui um nome, emoji e descrição exclusivos para esclarecer seu propósito. As categorias ajudam os mantenedores a organizar como as conversas são arquivadas. Eles são personalizáveis para ajudar a distinguir categorias que são perguntas e respostas ou conversas mais abertas. A tabela a seguir mostra as categorias padrão para discussões e sua finalidade.

Categoria Finalidade Formato
📣 Notícias Atualizações e notícias dos mantenedores do projeto Anúncio
#️⃣ Geral Tudo e qualquer coisa relevante para o projeto Discussão aberta
💡 Ideias Ideias para mudar ou melhorar o projeto Discussão aberta
🗳️ Sondagens Enquetes com várias opções para a comunidade votar e discutir Sondagens
🙏 Perguntas e respostas Perguntas para a comunidade responder, com um formato de pergunta/resposta Pergunta e Resposta
🙌 Mostrar e explicar Criações, experiências ou testes relevantes para o projeto Discussão aberta

Os mantenedores do repositório podem fixar discussões importantes na parte superior da guia Discussões para melhor visibilidade.

  1. Em Título da discussão , introduza um título para a discussão e, em Escrever , introduza o corpo da discussão.

    Uma captura de tela do início de uma nova página de discussão com a caixa Título da discussão e a caixa de conteúdo vazias.

  2. Selecione Iniciar discussão.

Isso aborda como o GitHub suporta a colaboração por meio de questões e discussões. Agora vamos passar para como você pode gerenciar notificações, assinar threads e começar a usar as páginas do GitHub.

Marcar um comentário como resposta

Em uma discussão no estilo P&R, você pode marcar um comentário como a resposta aceita para a pergunta original.

  1. Navegue até a discussão.
  2. Localize o comentário que melhor responde à pergunta original.
  3. Selecione Marcar como resposta abaixo do comentário.

O comentário será destacado, tornando mais fácil para os outros encontrarem a solução rapidamente. Você também pode desmarcar uma resposta, se necessário.

Referência a uma discussão numa questão

Se uma discussão levar a um trabalho que precisa ser rastreado, você pode converter a discussão em um problema.

  1. Navegue até a discussão que deseja converter.
  2. Selecione o ... menu (três pontos) no canto superior direito da discussão.
  3. Selecionar Referência na nova edição.
  4. Confirme o novo título e o corpo do problema.

Isto permite acompanhar o trabalho passível de ação proveniente de discussões da comunidade.

Fixar uma discussão

Você pode fixar discussões importantes na parte superior da página Discussões para melhor visibilidade.

  1. Navegue até a discussão que deseja fixar.
  2. Selecione o ... menu (três pontos) no canto superior direito da discussão.
  3. Selecione Fixar discussão.

As discussões afixadas são úteis para destacar anúncios, perguntas importantes ou tópicos em curso a que a comunidade deve prestar atenção.