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 e participar de problemas, pull requests e GitHub Discussions, dependendo do tipo de conversa que você gostaria de 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
- Muitas vezes são referidos como o sistema de rastreamento de erros do GitHub
Pull requests
- 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
GitHub Discussions
- São como um fórum e são mais utilizados para ideias e discussões de formato aberto 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 informações comunitária
- Frequentemente não têm um proprietário claro
- Muitas vezes não resultam em uma tarefa prática.
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.
- 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.
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 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.
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 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 issues" 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 obter mais informações, confira "Sobre solicitação 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 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."