Como acelerar pull requests em sua empresa com o GitHub Copilot

O guia é inspirado pelo ESSP (Guia estratégico do sistema de engenharia) do GitHub, que recomenda estratégias e métricas para impulsionar melhorias em sistemas de engenharia.

Se você estiver iniciando uma distribuição do Copilot, recomendamos definir suas metas, planejar a distribuição adequadamente e comunicar as metas com clareza à equipe. Confira Alcançar as metas de engenharia da sua empresa com o GitHub Copilot.

1. Identificar barreiras ao sucesso

A primeira etapa recomendada pelo ESSP é desenvolver uma compreensão clara dos obstáculos que impedem melhorias na empresa. Ao entender sua linha de base atual, seu estado futuro desejado e as barreiras que impedem o progresso, você pode garantir alterações direcionadas e eficazes.

As equipes geralmente enfrentam atrasos na mesclagem de pull requests devido a longos ciclos de revisão. Esses atrasos geralmente são resultado de:

Alterações de código complexas difíceis de entender
Formatação de código inconsistente, o que torna as revisões desafiadoras
Uma falta geral de contexto para as alterações
Fatores sociais que contribuem para revisões lentas ou difíceis de lidar

Os revisores também podem facilmente deixar passara pequenos erros que podem levar a problemas de produção.

Isso leva a gargalos no processo de desenvolvimento e reduz a entrega geral e a qualidade dos recursos.

2. Avaliar suas opções

A próxima etapa é avaliar e concordar com soluções para resolver as barreiras identificadas na etapa um. Neste guia, vamos focar o impacto que o GitHub Copilot pode ter na meta identificada. Lembre-se de que distribuições bem-sucedidas de uma nova ferramenta também exigem alterações na cultura e nos processos.

Você executará testes de novas ferramentas e processos com grupos piloto para coletar comentários e medir o sucesso. Para recursos de treinamento e métricas a serem usados durante as avaliações, leia as seções 3. Implementar alterações e Métricas a observar.

Inscreva-se no Copilot

Como o Copilot pode ajudar

O GitHub Copilot oferece um conjunto de recursos projetados para acelerar o processo de revisão de pull request, aprimorar a qualidade do código e melhorar a colaboração, levando a tempos de mesclagem mais rápidos.

Ao aproveitar as funcionalidades do , as equipes podem simplificar os fluxos de trabalho, reduzir o atrito e garantir um código consistente e de alta qualidade.

Gera resumos de PR completos e úteis

O Copilot pode gerar automaticamente resumos de PR claros e concisos, poupando tempo para os desenvolvedores e garantindo que a finalidade e as alterações da PR sejam facilmente compreendidas pelos revisores. Isso reduz a probabilidade de mal-entendidos e acelera o processo de revisão.

Ajuda os revisores no processo de revisão

O GitHub Copilot pode ser usado como um complemento avançado de revisão de PR.

O Copilot pode ajudar a explicar alterações de código complexas para que os revisores entendam mais rápido com o que a PR está contribuindo.
O Copilot pode dar sugestões com reconhecimento de contexto em todo o repositório e possíveis melhorias de código diretamente na interface de revisão de pull request no GitHub, ajudando os revisores a capturar possíveis problemas e fazer comentários construtivos com mais eficiência.
O Copilot pode ajudar os revisores a elaborar e escrever comentários de revisão claros, consistentes e eficazes.

Revisões com base nas diretrizes da organização

O Copilot pode examinar as alterações de código no IDE antes de abrir uma pull request ou ser atribuído como revisor a uma pull request.
Com conjuntos de regras, você pode configurar o Copilot para revisar sistematicamente pull requests com base em critérios personalizados.
Com diretrizes de codificação para revisões (apenas Copilot Enterprise), o Copilot pode impor padrões de codificação organizacional e práticas recomendadas, sinalizando automaticamente possíveis violações e sugerindo correções.

Esses recursos garantem consistência em toda a base de código e ajudam você a detectar erros no início do processo de desenvolvimento, reduzindo a necessidade de revisões manuais de código e poupando tempo para desenvolvedores e revisores.

Sugere correções de código

Com base em um comentário de revisão de pull request, o Copilot pode ajudar os autores da pull request a implementar rapidamente as alterações de código necessárias para resolver a revisão.

Considerações culturais

Além da distribuição do GitHub Copilot, você também deve abordar fatores sociais ou culturais que possam impedir que você atinja suas metas.

Os exemplos a seguir são extraídos da seção "Anti-Patterns" no ESSP.

As equipes podem esperar muito tempo para lançar, implantando grandes lotes de código de uma só vez. Isso pode ser causado pelo medo de desestabilização com versões frequentes, falta de maturidade de pipeline de CI/CD ou requisitos de conformidade estritos.
Os desenvolvedores podem gastar muito tempo aperfeiçoando o código ou adicionando recursos desnecessários. Isso pode ser causado por uma cultura de perfeccionismo ou falta de priorização efetiva.
Os desenvolvedores podem criar soluções excessivamente complexas para problemas simples. Isso pode ser devido a um desejo de desnecessariamente preparar para o futuro ou de pressão para agregar valor por meio da complexidade.

3. Implementar alterações

Quando você identificar a abordagem certa para superar suas barreiras, dimensionará as soluções identificadas. Para uma distribuição bem-sucedida de uma nova ferramenta ou processo, é importante atribuir a propriedade a cada parte da distribuição, comunicar-se de modo transparente sobre suas metas, fornecer treinamento eficaz e medir seus resultados.

Esta seção apresenta exemplos cenários, práticas recomendadas e recursos para desenvolvedores. É recomendável usar esta seção para planejar as sessões de comunicação e treinamento para ajudar os funcionários a usar o Copilot de um modo alinhado à meta.

Criar resumos de pull request úteis
Usar o Copilot como assistente de revisão
Adicionar o Copilot como revisor
Obter ajuda para implementar comentários de revisão
Práticas recomendadas para desenvolvedores
Recursos

Criar resumos de pull request úteis

Ao criar uma pull request, clique no ícone Copilot no campo "Add a description" e clique Summary.
O Copilot examinará a pull request e apresentará uma visão geral das alterações feitas em formato de texto, bem como uma lista com marcadores das alterações com os arquivos que elas afetam.
Verifique se você está satisfeito com a descrição do Copilot.
Quando os revisores chegarem à pull request, terão todo o contexto necessário para deixar uma revisão.

Usar o Copilot como assistente de revisão

Ao entrar em uma pull request como revisor, você pode usar o Copilot para acelerar sua revisão.

Use o Copilot para entender as alterações na pull request.
- Peça para o Copilot resumir as alterações feitas a um arquivo, o que é particularmente útil para diferenças mais longas. Você pode escolher um arquivo específico da comparação clicando em no canto superior direito do arquivo.
- Para alterações em linhas específicas, realce as linhas que você deseja entender melhor e peça para o Copilot explicar as alterações para você. Você pode realçar um conjunto de linhas clicando primeiro no número de linha superior, segurando sua tecla SHIFT e clicando na linha mais baixa da diferença.
Colabore na revisão de PR com o Copilot. Não se esqueça de anexar as diferenças de arquivo específicas à conversa antes de emitir o prompt ao Copilot.
- Você pode pedir a opinião do Copilot sobre as alterações de PR perguntando: Provide your judgement as a PR Reviewer, both for functional and non-functional aspects that these changes bring. Observe como esse prompt pede para o Copilot considerar aspectos funcionais e não funcionais do código.
- Para seus próprios comentários de revisão de PR, peça uma segunda opinião ao Copilot: As my peer reviewer on this pull request, give me your feedback on my own review: YOUR-REVIEW-COMMENT. Do you think it's pertinent? Am I missing something?
Colabore com o Copilot para criar um rascunho e refinar seus comentários de revisão.
- Depois de planejar a revisão com o Copilot, você pode pedir para listar os comentários que você deve fazer: Make a list of review comments to add to the PR and tell me exactly in which file diff and lines each comment should be added.
- Você também pode pedir para o Copilot criar um primeiro rascunho de um comentário de revisão que você tenha em mente ou refinar um comentário antes de postá-lo: Help me draft review comments as discussed ou Refine this review comment to make it clear, concise, and actionable.

Adicionar o Copilot como revisor

Para reduzir os tempos de revisão e mesclar solicitações de pull mais rapidamente, use as revisões de código do Copilot sistematicamente: primeiro no IDE antes de abrir a pull request, em seguida, na PR no GitHub.

O uso da revisão de código do Copilot não substitui a necessidade de revisão de código humano. Porém, seguir as etapas acima pode ajudar os humanos a concluir as revisões mais rápido.

Os desenvolvedores devem solicitar uma revisão de todas as alterações usando a revisão de código do Copilot antes de abrir uma pull request.
Os administradores devem configurar conjuntos de regras do repositório ou da organização para adicionar automaticamente o Copilot como um revisor em qualquer pull request direcionada a branches protegidos.
Os líderes da equipe devem capturar o estilo e as regras padrão da equipe e defini-los como diretrizes de codificação para a organização para que o Copilot possa aproveitá-los em revisões.
- Verifique se as diretrizes de codificação capturam um conjunto mínimo de recomendações de estilo que tornam o código mais legível, o que ajudará no processo de revisão de pull request.
- Para reduzir a quantidade de comentários de revisão de PR devido a problemas de estilo, defina as mesmas recomendações em instruções do Copilot no nível do repositório e da organização. Dessa forma, o código gerado por Copilot estará em conformidade com essas diretrizes.

Obter ajuda para implementar comentários de revisão

Os autores de pull request podem acelerar a resolução de comentários de revisão de PR implementando rapidamente correções com a assistência do Copilot.

Para comentários de revisão deixados pelo Copilot em si, confirme a correção proposta diretamente ou edite-a no Workspace do Copilot antes de fazer commit.
Para comentários de revisão deixados por pares, navegue até a comparação de arquivo relacionada ao comentário de revisão de PR e anexe a comparação a uma conversa do Copilot Chat. Em seguida, copie o comentário de revisão com um prompt como este: Suggest a fix for this review comment:
Se estiver usando o VS Code, no modo de agente, peça para o GitHub Copilot implementar as alterações necessárias do comentário de revisão.

Práticas recomendadas para desenvolvedores

Os desenvolvedores devem:

Solicitar a revisão do Copilot no IDE antes de enviar por push para capturar e resolver problemas cedo.
Usar o Copilot para planejar e refinar seus próprios comentários de revisão de PR para ajudar os autores de PR a entender e resolver problemas.
Anexar o contexto de comparação relevante, incluindo linhas de código específicas, às suas conversas com o Copilot.

Os desenvolvedores não devem:

Aplicar as sugestões do Copilot sem testar.
Confiar apenas no Copilot para análises.
Negligenciar a legibilidade do código.

Recursos

Métricas a observar

Para analisar avaliações de novas ferramentas e garantir que suas distribuições completas estejam fornecendo melhorias consistentes, monitore os resultados e faça ajustes quando necessário. Em geral, recomendamos considerar as principais zonas de qualidade, velocidade e satisfação do desenvolvedor e como essas zonas se reúnem para contribuir com os resultados dos negócios.

Aqui estão algumas métricas que recomendamos analisar para avaliar o impacto do Copilot nessa meta específica.

Satisfação do desenvolvedor: use pesquisas de desenvolvedor para medir a satisfação com as ferramentas de engenharia.
Pull requests mescladas por desenvolvedor: você pode usar o webhook pull request do GitHub, garantindo que action seja closed e a propriedade pull request dentro do objeto merged seja true.
Prazo de entrega de pull requests: meça o tempo médio entre a criação e a mesclagem de PR.