Skip to main content

Comunicar-se no GitHub

Você pode discutir projetos e alterações específicas, bem como ideias mais amplas ou objetivos de equipe, usando diferentes tipos de discussões em GitHub.

Introdução

GitHub fornece ferramentas de comunicação colaborativa embutidas que permitem que você interaja de perto com sua comunidade. Este guia de início rápido irá mostrar como escolher a ferramenta certa para suas necessidades.

Você pode criar problemas, solicitações de pull, GitHub Discussions e discussões em equipe e participar deles, dependendo do tipo de conversa que deseja ter.

GitHub Issues

  • são úteis para discutir detalhes específicos de um projeto como relatórios de erros, melhorias e feedbacks planejados.
  • são específicos para um repositório e geralmente têm um proprietário claro.
  • muitas vezes são referidos como o sistema de rastreamento de erros de GitHub.

Solicitações de pull

  • permite que você proponha alterações específicas.
  • permite que comente diretamente as alterações propostas por outros.
  • são específicos para um repositório.

GitHub Discussions

  • são como um fórum e são mais utilizados para ideias de forma aberta e discussões em que a colaboração é importante.
  • poderá incluir muitos repositórios.
  • oferecem uma experiência colaborativa fora da base de código, permitindo o debate de ideias e a criação de uma base de conhecimento comunitária.
  • frequentemente não têm um proprietário claro.
  • muitas vezes não resultam em uma tarefa exequível.

Discussões em equipe

  • na página da sua equipe podem ser iniciadas para conversas que abrangem projetos e não pertencem a um problema específico ou pull request. Em vez de abrir uma issue em um repositório para discutir uma ideia, você pode incluir toda a equipe tendo uma conversa em uma discussão de equipe.
  • permitem que você realize discussões com sua equipe sobre planejamento, análise, design, pesquisa de usuário e tomada de decisão geral do projeto em um só lugar.

Que ferramenta de discussão devo usar?

Cenários para problemas

  • Quero acompanhar as tarefas, melhorias e erros.
  • Eu quero arquivar um relatório de erro.
  • Quero partilhar o feedback sobre um recurso específico.
  • Quero fazer uma pergunta sobre os arquivos do repositório.

Exemplo de problema

Este exemplo ilustra como um usuário do GitHub criou um problema na nossa documentação de repositório de código aberto para chamar a nossa atenção para um erro e discutir uma correção.

Exemplo de problema

  • Um usuário notou que a cor azul do banner na parte superior da página na versão em chinês da documentação do GitHub torna o texto no banner ilegível.
  • O usuário criou um problema no repositório, identificando o problema e sugerindo uma correção (que se trata de usar uma cor de fundo diferente para o banner).
  • Uma discussão se inicia e, eventualmente, será alcançado um consenso sobre a correção a ser aplicada.
  • Em seguida, um contribuidor pode criar um pull request com a correção.

Cenários para pull requests

  • Eu quero corrigir um erro de digitação em um repositório.
  • Quero fazer alterações em um repositório.
  • Eu quero fazer alterações para consertar um problema.
  • Eu quero comentar as alterações sugeridas por outras pessoas.

Exemplo de solicitação de pull

Este exemplo ilustra como um usuário do GitHub criou um pull request na nossa documentação do repositório de código aberto para corrigir um erro de digitação.

Na guia Conversa da solicitação de pull, o autor explica o motivo da criação da solicitação de pull.

Exemplo de pull request - aba Conversa

A guia Arquivos alterados da solicitação de pull mostra a correção implementada.

Exemplo de pull request - Aba de Arquivos alterados

  • Este contribuidor observa um erro de digitação no repositório.
  • O usuário cria um pull request com a correção.
  • Um mantenedor do repositório revisa o pull request, comenta e faz merge nela.

Cenários para GitHub Discussions

  • Tenho uma pergunta que não é necessariamente relacionada a arquivos específicos no repositório.
  • Eu quero compartilhar notícias com meus colaboradores ou com minha equipe.
  • Eu quero começar ou participar de uma conversa aberta.
  • Eu quero fazer um anúncio à minha comunidade.

Exemplo de GitHub Discussions

Este exemplo mostra a postagem de boas-vindas de GitHub Discussions para a documentação do repositório de código aberto GitHub e ilustra como a equipe quer colaborar com sua comunidade.

Exemplo de GitHub Discussions

Este mantenedor da comunidade iniciou uma discussão para dar as boas-vindas à comunidade e pedir aos integrantes que se apresentem. Esta postagem promove uma atmosfera de acolhedora para visitantes e contribuidores. A postagem também esclarece que a equipe tem o prazer em ajudar com as contribuições para o repositório.

Cenários para discussões em equipe

  • Tenho uma pergunta que não é necessariamente relacionada a arquivos específicos no repositório.

  • Eu quero compartilhar notícias com meus colaboradores ou com minha equipe.

  • Eu quero começar ou participar de uma conversa aberta.

  • Eu quero fazer um anúncio à minha equipe.

    Como você pode ver, as discussões em equipe são muito parecidas com o GitHub Discussions. Para GitHub.com, recomendamos usar GitHub Discussions como ponto de partida para conversas. Você pode usar GitHub Discussions para colaborar com qualquer comunidade em GitHub. Se você faz parte de uma organização e gostaria de iniciar conversas dentro da sua organização ou equipe dentro dessa organização, você deverá usar discussões de equipe.

Exemplo de discussão em equipe

Este exemplo mostra uma postagem da equipe para a equipe octo-team.

Exemplo de discussão em equipe

O membro da equipe octocat postou uma discussão em equipe, informando a equipe de várias coisas:

  • Um integrante da equipe denominado Mona iniciou eventos remotos de jogos.
  • Há uma postagem no blogue que descreve como as equipes usam GitHub Actions para produzir sua documentação.
  • Material sobre a "All Hands" de Abril agora está disponível para ver todos os integrantes da equipe.

Próximas etapas

Estes exemplos mostraram como decidir qual é a melhor ferramenta para suas conversas em GitHub. Mas esse é apenas o começo; há muito mais que você pode fazer para adaptar essas ferramentas às suas necessidades.

Para problemas, por exemplo, você pode marcar problemas com etiquetas para uma pesquisa mais rápida e criar modelos de problemas para ajudar os colaboradores a abrir problemas significativos. Para obter mais informações, confira "Sobre os modelos de solicitações de pull e de problemas".

Para pull requests, você pode criar pull requests de rascunho se as suas alterações propostas ainda forem um trabalho em andamento. Não é possível fazer o merge dos pull requests de rascunho até que estejam prontos para revisão. Para obter mais informações, confira "Sobre as solicitações de pull".

Para o GitHub Discussions, você pode configurar um código de conduta e fixar discuessões que contêm informações importantes para sua comunidade. Para obter mais informações, confira "Sobre as discussões".

Para discussões em equipe, você pode editar ou excluir discussões na página de uma equipe, além de poder configurar notificações para discussões em equipe. Para obter mais informações, confira "Sobre as discussões em equipe".

Para saber mais sobre alguns recursos de formatação avançada que ajudarão você a se comunicar, confira "Guia de início rápido para escrever em GitHub".