Explorar o fluxo do GitHub

Concluído

O GitHub é a melhor ferramenta para habilitar a colaboração em seus projetos. O GitHub Flow é um workflow baseado em ramificações sugerido pelo GitHub.

Nota

Para implementar o fluxo do GitHub, você precisará de uma conta do GitHub e de um repositório. Consulte "Inscrever-se no GitHub" e "Criar um repositório".

Dica

Você pode concluir todas as etapas do fluxo do GitHub por meio da interface da Web do GitHub, linha de comando, da CLI do GitHub ou do GitHub Desktop.

A primeira etapa é criar um branch em seu repositório para funcionar sem afetar o branch padrão e você dá aos colaboradores a chance de revisar seu trabalho.

Para obter mais informações, consulte "Criando e excluindo branches do seu repositório."

Captura de tela de um modelo de ramificação que representa a criação do ramo.

Faça as alterações desejadas no repositório. Se você cometer um erro, poderá reverter ou fazer alterações adicionais para corrigi-lo.

Confirme suas alterações e faça push no seu branch para salvar seu trabalho no armazenamento remoto, dando a cada confirmação uma mensagem descritiva. Cada commit deve conter uma alteração isolada e completa, facilitando a reversão se você adotar uma abordagem diferente.

Qualquer pessoa que colabore com seu projeto pode ver seu trabalho, responder perguntas e fazer sugestões ou contribuições. Continue a criar, confirmar e enviar alterações por push ao branch até que você esteja pronto para solicitar comentários.

Dica

Você pode criar um branch separado para cada alteração para facilitar que os revisores enviem comentários ou entendam as diferenças.

Quando estiver pronto, você poderá criar uma solicitação de pull para solicitar comentários aos colaboradores sobre suas alterações. Consulte "Criando uma solicitação de pull."

A revisão de solicitação de pull é um dos recursos mais valiosos da colaboração. Você pode exigir aprovação de seus colegas e equipe antes de mesclar alterações. Além disso, você pode marcá-lo como um rascunho caso queira comentários ou conselhos antecipados antes de concluir suas alterações.

Captura de tela de um modelo de ramificação que representa uma solicitação de pull aberta.

Descreva a solicitação de pull o máximo possível com as alterações sugeridas e qual problema você está resolvendo. Você pode adicionar imagens, links, problemas relacionados ou qualquer informação para documentar sua alteração e ajudar os revisores a entender a PR sem abrir cada arquivo. Consulte "A sintaxe básica de escrita e formatação" e "Como vincular uma solicitação de pull a um problema".

Captura de tela de abrir uma representação de solicitação pull com o campo de descrição, o problema relacionado e um modelo de lista de verificação.

Outra maneira de melhorar a qualidade e a documentação de RP e apontar explicitamente algo para os revisores é usar a área de sessão de comentários. Além disso, você pode @mention ou solicitar uma revisão de pessoas ou equipes específicas.

Captura de tela do campo de comentário da solicitação de pull.

Há outras configurações de Pull Requests, como solicitar automaticamente uma revisão de equipes ou usuários específicos quando uma solicitação de pull request é criada, ou executar verificações nas solicitações de pull request. Para obter mais informações, consulte "Sobre verificações de status" bem como "Sobre ramificações protegidas".

Após a validação dos comentários e verificações dos revisores, as alterações devem estar prontas para serem mescladas, e eles podem aprovar o Pull Request. Veja Mesclando um pull request.

Se você tiver conflitos, o GitHub informará você para resolvê-los. "Resolvendo conflitos de mesclagem."

Captura de tela de um modelo de ramificação que representa a mesclagem de branches.

Depois que uma solicitação de pull bem-sucedida é mesclada, não há necessidade do branch remoto permanecer lá. Você pode excluir sua ramificação para impedir que outras pessoas usem ramificações antigas acidentalmente. Para obter mais informações, consulte "Excluindo e restaurando ramificações em um pull request."

Nota

O GitHub mantém o histórico de confirmação e mesclagem se você precisar restaurar ou reverter sua solicitação de pull.