Sobre solicitação de pull

  • Artigo

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

As PRs (solicitações de pull) são uma forma de alterar, revisar e mesclar código em um Repositório do Git em Azure Repos. Os PRs podem vir de branches dentro do mesmo repositório ou de branches em forks do repositório. As equipes usam PRs para revisar o código e fornecer comentários sobre as alterações antes de mesclar o código no branch principal. Os revisores podem executar as alterações propostas, deixar comentários e votar para aprovar ou rejeitar o código.

Este artigo descreve as diretrizes de solicitação de pull e as considerações de gerenciamento. Para obter instruções sobre como criar, exibir, revisar e concluir solicitações de pull, consulte os seguintes artigos:

Observação

Por motivos de desempenho e estabilidade, o número de revisores que podem ser adicionados a uma pull request deve ser igual ou inferior a 1000. Novas pull requests não serão criadas ao adicionar mais de 1000 revisores, e as pull requests existentes não permitirão que você adicione mais de 1000 revisores.

Permissões e pré-requisitos

  • Os repositórios devem estar habilitados em seu projeto. Se o hub Repos e as páginas associadas não forem exibidos, consulte Ativar ou desativar um serviço do Azure DevOps para reabilitar os repositórios.

  • Para exibir ou examinar PRs, você deve ser membro de um projeto do Azure DevOps com acesso Básico ou superior.

  • Para contribuir com uma PR, você deve ser membro do grupo de segurança Leitores ou ter as permissões correspondentes.

  • Para criar e concluir uma PR, você deve ser membro do grupo de segurança Colaboradores ou ter as permissões correspondentes.

Observação

Para projetos públicos, os usuários que receberam acesso de Stakeholder têm acesso total a Azure Repos.

  • Os repositórios devem estar habilitados em seu projeto. Se o hub Repos e as páginas associadas não forem exibidos, consulte Ativar ou desativar um serviço do Azure DevOps para reabilitar os repositórios.
  • Para exibir ou examinar PRs, você deve ser membro de um projeto do Azure DevOps com acesso Básico ou superior. Se você não for um membro do projeto, será adicionado.
  • Para contribuir com uma PR, você deve ser membro do grupo de segurança Leitores ou ter as permissões correspondentes.
  • Para criar e concluir uma PR, você deve ser membro do grupo de segurança Colaboradores ou ter as permissões correspondentes.

Para saber mais sobre permissões e acesso, consulte Repositório do Git padrão e as permissões de branch e Sobre os níveis de acesso.

Comentários de qualidade para solicitações de pull

As revisões de alta qualidade começam com comentários de alta qualidade. Veja aqui algumas chaves para ótimos comentários de PR:

  • O proprietário da PR deve ter as pessoas certas para examinar a PR e garantir que os revisores saibam o que faz o código.
  • Os revisores devem fornecer comentários acionáveis e construtivos.
  • Proprietários e revisores devem comentar e responder rapidamente.

Os proprietários de PR devem:

  • Confirmar se selecionaram os revisores certos a serem atribuídos a uma PR.
  • Incluir revisores que sabem como funciona o código.
  • Solicitar os desenvolvedores que trabalham em outras áreas para compartilhar suas ideias.
  • Fornecer uma descrição clara das alterações.
  • Fornecer diretrizes do revisor com modelos de solicitação de pull.
  • Fornecer um build do código com a correção ou o recurso em execução.
  • Responda aos comentários, aceitando a sugestão ou explicação da alteração sugerida não ser ideal.
  • Para obter boas sugestões fora do escopo da PR, crie novos itens de trabalho, branches e PRs para fazer essas alterações.

Revisores devem fazer as seguintes tarefas.

  • Fornecer comentários sobre as alterações com as quais não concordam
  • Identificar os problemas e oferecer sugestões específicas sobre o que fazer de forma diferente
  • Verificar se os comentários têm uma intenção clara e é fácil de entender
  • Deixe comentários ou vote em alterações

Para obter mais informações, consulte Obter comentários com pull requests do Git.

Políticas de branch e solicitações de pull

Sua equipe pode contar com branches críticos em seu repositório, como o branch main para estar sempre em boa forma. É possível definir as políticas de branch para exigir PRs para quaisquer alterações nesses branches protegidos e rejeitar quaisquer alterações enviadas diretamente para os branches.

É possível adicionar mais políticas a PRs para aplicar uma melhor qualidade de código em branches principais. Requisitos extras, como um build limpo do código proposto ou aprovação de vários revisores, podem ajudar a proteger os branches principais.

É possível definir o número de aprovações necessárias para uma PR em uma política de branch. Também é possível definir determinados revisores para que sejam obrigatórios ou opcionais em todos ou determinados PRs. Uma PR pode ser definida como preenchimento automático com o número necessário de aprovações, mesmo que outros revisores rejeitem as alterações. No entanto, os revisores obrigatórios devem aprovar PRs antes que possam se mesclar. É uma prática recomendada que, pelo menos, dois revisores analisem e aprovarem as alterações em uma PR.

Para redefinir votos sempre que um autor de PR enviar novas alterações, selecione Redefinir votos do revisor de código quando houver novas alterações na política Exigir um número mínimo de revisores.

A tabela a seguir resume as políticas que você pode definir para personalizar um branch. Para obter uma visão geral de todas as políticas e configurações dos repositórios e branches, consulte Configurações e políticas do repositório Git.

Política

Default

Descrição

Exigir um número mínimo de revisores

Desativado

Exigir aprovação de um número especificado de revisores em solicitações de pull.

Verificar se há itens de trabalho vinculados

Desativado

Incentivar a rastreabilidade verificando os itens de trabalho vinculados nas solicitações de pull

Verificar a resolução de comentários

Desativado

Verificar se todos os comentários foram resolvidos nas solicitações de pull.

Limitar os tipos de mesclagem

Desativado

Controlar o histórico do branch limitando os tipos disponíveis de mesclagem quando as solicitações de pull são concluídas.

Adicionar políticas de validação de build

Desativado

Adicionar uma ou mais políticas para validar o código fazendo a pré-mesclagem e criando alterações nas solicitações de pull. Também pode habilitar ou desabilitar políticas.

Adicionar políticas de Verificação de Status

Desativado

Adicionar uma ou mais políticas para exigir que outros serviços tenham status bem-sucedidos para concluir as solicitações de pull. Também pode habilitar ou desabilitar políticas.

Revisores incluídos automaticamente

Desativado

Adicionar uma ou mais políticas para indicar revisores de código a serem incluídos automaticamente quando as solicitações de pull alterarem determinadas áreas do código. Também pode habilitar ou desabilitar políticas.

Para obter mais informações, consulte:

Definir verificações de status para melhorar a qualidade do código

As solicitações de pull e as políticas de branch permitem que as equipes adotem as melhores práticas para revisar o código e executar builds automatizados. Muitas equipes têm requisitos e validações adicionais feitas no código. Para cobrir essas necessidades, você pode integrar verificações de status de PR ao fluxo de trabalho de PR. Com as verificações de status de PR, os serviços externos podem assinar programaticamente as alterações de código associando informações de êxito ou falha à PR.

Para obter mais informações, consulte os seguintes artigos:

Problema de base de mesclagem múltipla

Em alguns casos, uma PR tem mais de uma base de mesclagem verdadeira e essa situação pode causar problemas de segurança. Se os arquivos na PR tiverem versões diferentes entre as bases de mesclagem, um aviso base de mesclagem múltipla será exibido. Para obter mais informações e correção, consulte Várias bases de mesclagem.

Próximas etapas