Uma solicitação de pull propõe alterações em um branch separado da base de código principal para que outras pessoas possam examinar as alterações antes de serem mescladas. Este guia de início rápido mostra a maneira mais simples de criar um pull request. Você criará uma ramificação, fará e confirmará alterações, abrirá uma solicitação de pull, responderá aos comentários e mesclará.
Você pode acompanhar pelo site GitHub ou com GitHub CLI, selecionando uma das abas acima.
Ramificar ou bifurcar o repositório
Você começará criando um local isolado para trabalhar.
- Em GitHub, navegue até a página principal do repositório no qual você deseja propor alterações.
- Se você não tiver permissão de escrita, precisará de um fork. Clique em Bifurcação no canto superior direito e siga as etapas. Em seguida, continue na bifurcação do repositório.
- Clique no menu seletor de ramificação na parte superior da lista de arquivos. Provavelmente diz principal. Digite um novo nome de ramificação e clique em Criar ramificação new-branch-name a partir de main.
-
Para usar GitHub CLI, você precisará instalá-lo primeiro. Consulte Início rápido da CLI GitHub.
-
Clone o repositório. Ou bifurque o repositório e clone-o localmente ao mesmo tempo.
-
Se você tiver acesso de gravação ao repositório, clone o repositório:
gh repo clone OWNER/REPO -
Se você não tiver acesso de gravação, você criará um fork primeiro e clonará tudo de uma vez.
gh repo fork OWNER/REPO --clone
-
Mude para o diretório do repositório clonado.
cd REPO -
Crie e mude para uma nova ramificação.
git checkout -b YOUR-BRANCH-NAME
Criar ou editar seu código
Faça suas alterações no ramo. Para sua primeira solicitação de pull, mantenha a alteração focada e simples. Solicitações de pull menores são mais rápidas de examinar e mais fáceis de mesclar.
Experimente um dos seguintes procedimentos para fazer suas alterações:
- Edite arquivos localmente no IDE ou em um editor de texto.
- Edite um arquivo diretamente no GitHub navegando até ele e clicando .
Confirmar com frequência
Salve seu trabalho em commits pequenos e relevantes. Cada commit registra uma captura e uma mensagem descrevendo a alteração.
git add .
git commit -m "Describe your change"
git push --set-upstream origin YOUR-BRANCH-NAME
Ao editar um arquivo GitHub e estiver pronto para confirmar, você inserirá uma mensagem de confirmação e se comprometerá diretamente com seu branch.
- Clique em Confirmar alterações....
- Na caixa de mensagem Confirmar , insira uma breve descrição das alterações feitas.
- Selecione a ramificação na qual você está trabalhando.
- Clique em Propor alterações.
Sua alteração será adicionada e registrada na ramificação.
Abra sua solicitação de pull
Quando sua ramificação tiver as alterações que você deseja propor, abra um pull request tendo como destino a ramificação base.
- Na página principal do repositório, clique em Solicitações de pull e, em seguida, clique em Nova solicitação de pull.
- Para a ramificação base, main provavelmente já está selecionada e normalmente é a ramificação base na qual você vai integrar as alterações.
- Para o branch de comparação, selecione o branch que contém suas alterações.
- Clique em Criar solicitação de pull.
- Insira um título e uma descrição que explica o que você mudou e por quê.
- Você pode criar uma solicitação de pull pronta para revisão ou uma que esteja em um estado de rascunho.
- Se estiver pronto para revisão, clique em Criar solicitação de pull.
- Para compartilhar um trabalho em andamento, use a lista suspensa e selecione Criar pull request em rascunho.
Você pode criar uma solicitação de pull pronta para revisão ou uma que esteja em um estado de rascunho.
-
Se estiver pronto para revisão:
gh pr create -
Para compartilhar um trabalho em andamento
gh pr create --draft
Em seguida, siga as instruções para definir a branch de base, o título e a descrição.
Se você fizer mais confirmações no mesmo branch, elas serão adicionadas automaticamente à sua solicitação de pull.
Solicitar uma revisão
Para solicitar uma revisão por meio da caixa Revisores, você precisa ter acesso de gravação ao repositório e pode solicitar uma revisão a uma pessoa ou equipe com acesso de leitura ao repositório. Se você solicitar uma revisão, a pessoa ou a equipe receberá uma notificação. Em alguns casos, você verá revisores sugeridos que podem ser selecionados.
Se a caixa Revisores não estiver disponível para você, você poderá:
- Verifique o README do repositório para consultar as orientações sobre revisões de pull request e siga essas instruções.
- Se você conhece uma pessoa que pode fazer a revisão para você, entre em contato com ela e compartilhe o link para sua solicitação de pull.
Tratar o feedback da revisão
Os revisores podem comentar, sugerir alterações ou solicitar alterações antes que uma solicitação de pull possa ser mesclada.
- Para aceitar a sugestão de um revisor, clique em Sugestão de Confirmação (ou lote vários e clique em Sugestões de Confirmação).
- Para fazer alterações mais amplas, edite seu código e envie novas confirmações por push para o mesmo branch. A solicitação de pull é atualizada automaticamente e executará novamente todas as verificações.
- Marque cada conversa como Resolvida depois de endereçá-la.
Mesclar e implantar
Depois que as revisões necessárias e as verificações de status forem aprovadas, mescle a solicitação de pull para colocar suas alterações no branch base. Se você decidir não mesclar as alterações, poderá fechar a solicitação de pull.
Dica
Repositórios diferentes podem ter requisitos diferentes para mesclagem. Examine as diretrizes relevantes e siga suas instruções.
- Na parte inferior da solicitação de pull, clique em Mesclar solicitação de pull.
- Clique em Confirmar para concluir a mesclagem.
- (Opcional) Exclua o branch principal para manter o repositório arrumado.
gh pr merge
Siga os prompts para escolher um método de mesclagem e, opcionalmente, excluir o branch.
Próximas Etapas
Após seu primeiro pull request, tente revisar o trabalho de outra pessoa. Consulte Guia de início rápido para revisar pull requests.