Ajudando outras pessoas a revisar suas alterações

Você pode usar pull requests para fornecer contexto claro para suas alterações e manter sua equipe informada, melhorando a colaboração e a qualidade das revisões.

Neste artigo

Quando cria uma pull request, você está pedindo à sua equipe que revise suas alterações e forneça comentários. Este guia fornece as práticas recomendadas para criar pull requests fáceis de revisar e manter sua equipe informada, para que você possa melhorar a colaboração e a qualidade das revisões.

Facilitando a revisão de suas alterações

Um contexto claro nas pull requests ajuda os revisores a ver rapidamente o que você mudou e por que a alteração é importante. Isso torna o processo de revisão mais rápido e suave, com menos vai-e-vem, e ajuda a equipe a fazer melhores comentários e tomar decisões informadas. Para obter mais informações sobre a criação de pull requests, confira Como criar uma solicitação de pull.

Escrever pull requests pequenas

Procure criar pull requests pequenas, com foco, que atendam a um propósito único. Pull requests menores são mais fáceis e rápidas de revisar e mesclar, deixam menos espaço para bugs, além de fornecer um histórico mais claro das alterações.

Forneça contexto e orientação

Escreva títulos e descrições claras para suas pull requests, para que os revisores consigam entender rapidamente o propósito da solicitação. Inclua o seguinte no corpo da pull request:

  • A finalidade da pull request
  • Uma visão geral das alterações
  • Links para algum contexto adicional, como problemas de acompanhamento ou conversas anteriores

Para ajudar os revisores, compartilhe o tipo de feedback necessário. Por exemplo, você precisa de uma conferida rápida ou de uma crítica mais profunda?

Se sua pull request consistir em alterações em vários arquivos, forneça orientação aos revisores sobre a ordem de revisão dos arquivos. Recomende por onde a revisão deve começar e como proceder.

Revise sua própria pull request primeiro

Revise, crie e teste sua própria pull request antes de enviá-la. Isso permitirá que você detecte erros gerais e de digitação que você pode ter deixado passar, antes que outros comecem a revisar.

Revisão de segurança

Há várias ferramentas disponíveis que podem ajudar você a revisar sua pull request quanto a possíveis problemas de segurança antes que outras pessoas a revisem. A revisão de segurança ajuda a capturar e resolver problemas de segurança antecipadamente e permite que você realce riscos não resolvidos para outras pessoas revisarem e aconselharem. Por exemplo, você pode:

Mantendo a equipe informada

Pull requests podem fazer mais do que apenas documentar alterações de código. Elas também são uma maneira poderosa de manter sua equipe e seu gerente informados sobre o status do trabalho. Ao deixar seu progresso visível em pull requests, você pode reduzir a necessidade de atualizações separadas e garantir que todos permaneçam alinhados.

Conecte sua pull request a problemas ou quadros de projeto relevantes para mostrar como seu trabalho se encaixa no projeto maior.

  • Adicione palavras-chave como Closes ISSUE-LINK à descrição para vincular e fechar automaticamente o problema quando a pull request for mesclada.
  • Use Projects para acompanhar seu trabalho e vincular ao projeto a partir de sua pull request, facilitando o acompanhamento de progresso em um só lugar. Confira Sobre Projects.

Realçar o status com rótulos

Adicione um rótulo de status à sua pull request para mostrar se ela está pronta para revisão, bloqueada ou em andamento. Isso ajuda os revisores a entender o estado do trabalho rapidamente. Para saber mais, confira Gerenciar etiquetas.