Introdução
GitHub fornece ferramentas de comunicação colaborativas internas, permitindo 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.
É possível criar problemas e participar deles, pull requests e discussões em equipe, dependendo do tipo de conversa que você deseja ter.
GitHub Issues
- São úteis para discutir detalhes específicos de um projeto como relatórios de bugs, melhorias e feedbacks planejados
- São específicos para um repositório e geralmente têm um proprietário claro
- São frequentemente chamados de sistema de rastreamento de bugs do GitHub
Solicitações de pull
- Permite que você proponha alterações específicas
- Permite que você comente diretamente as alterações propostas por outros
- São específicos para um repositório
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 GitHub abriu uma issue em nosso repositório código aberto de documentação para nos alertar sobre um bug e discutir uma correção.
- Um usuário notou que a cor azul da faixa na parte superior da página na versão chinesa do GitHub Docs torna o texto na faixa 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 solicitações de pull
- 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 GitHub usuário criou um pull request em nosso repositório de código aberto da documentação para corrigir um erro de digitação.
Na aba Conversa da solicitação de pull, o autor explica por que criou a solicitação de pull.
A guia Arquivos alterados da solicitação de pull mostra a correção implementada.
- 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 sobre ele e realiza a mesclagem nele.
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.
GitHub Discussions exemplo
Este exemplo mostra a GitHub Discussions publicação de boas-vindas para o GitHub repositório de código aberto Docs e ilustra como a equipe quer colaborar com sua comunidade.
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.
Próximas etapas
Estes exemplos mostraram a você 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 saber mais, confira Sobre problemas e Sobre modelos de problema e pull request.
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 saber mais, confira Sobre solicitação de pull.
Em GitHub Discussions, você pode fixar discussões com informações importantes para a sua comunidade. Para saber mais, confira Sobre discussões.
Para aprender alguns recursos avançados de formatação que ajudarão você a se comunicar, confira Guia de início rápido de gravação no GitHub.