Acelerando solicitações de pull em sua empresa com 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 que as revisões se tornem lentas ou difíceis de serem abordadas

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. As distribuições bem-sucedidas de uma nova ferramenta também exigem alterações na cultura e nos processos.

Execute avaliações de novas ferramentas e processos com grupos piloto para coletar comentários e medir o sucesso. Para obter recursos e métricas de treinamento a serem usados durante as avaliações, consulte as seções 3. Implementar alterações e Métricas a monitorar.

          <a href="https://github.com/enterprise/contact?ref_product=copilot&ref_type=engagement&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline">
          <span>Fale com Vendas</span><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-link-external" aria-label="link external icon" role="img"><path d="M3.75 2h3.5a.75.75 0 0 1 0 1.5h-3.5a.25.25 0 0 0-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 0 0 .25-.25v-3.5a.75.75 0 0 1 1.5 0v3.5A1.75 1.75 0 0 1 12.25 14h-8.5A1.75 1.75 0 0 1 2 12.25v-8.5C2 2.784 2.784 2 3.75 2Zm6.854-1h4.146a.25.25 0 0 1 .25.25v4.146a.25.25 0 0 1-.427.177L13.03 4.03 9.28 7.78a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042l3.75-3.75-1.543-1.543A.25.25 0 0 1 10.604 1Z"></path></svg></a>

Como Copilot pode ajudar

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

Aproveitando Copilotos recursos, as equipes podem simplificar seus fluxos de trabalho, reduzir o atrito e garantir um código consistente e de alta qualidade.

Gera resumos de PR completos e úteis

          Copilot pode gerar automaticamente resumos de PR claros e concisos, economizando tempo para os desenvolvedores e garantindo que a finalidade e as alterações do 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

          GitHub Copilot pode ser usado como um companheiro de revisão de RP avançado.

Copilot pode ajudar a explicar alterações de código complexas, permitindo que os revisores entendam mais rapidamente o que o PR contribui.
Copilot pode fornecer sugestões contextuais em todo o repositório e possíveis aprimoramentos de código diretamente na interface de revisão de solicitação de pull do GitHub, ajudando os revisores a identificar possíveis problemas e oferecer feedback construtivo com mais eficiência.
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

Copilot pode examinar as alterações de código no IDE antes de abrir uma solicitação de pull ou ser atribuído como revisor a uma solicitação de pull.
Com conjuntos de regras, você pode configurar Copilot para revisar sistematicamente as solicitações de pull com base em critérios personalizados.
Com instruções personalizadas para revisões, 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 solicitação de pull, Copilot pode ajudar os autores da solicitação de pull a implementar rapidamente as alterações de código necessárias para resolver a revisão.

Considerações culturais

Juntamente com o lançamento do GitHub Copilot, aborde quaisquer fatores sociais ou culturais que possam impedi-lo de atingir seus objetivos.

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 lançamentos frequentes, pela falta de maturidade do pipeline de CI/CD ou por requisitos de conformidade rigorosos.
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 correta para superar seus obstáculos, amplie as soluções que identificou. Para uma distribuição bem-sucedida de uma nova ferramenta ou processo, atribua a propriedade a cada parte da distribuição, comunique-se de forma transparente sobre suas metas, forneça treinamento eficaz e meça seus resultados.

Esta seção apresenta exemplos cenários, práticas recomendadas e recursos para desenvolvedores. Use esta seção para planejar comunicações e sessões de treinamento para ajudar os funcionários a usar Copilot de uma maneira que esteja alinhada com seu objetivo.

Criar resumos úteis de pull requests
Usar Copilot como assistente de revisão
Adicionar 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 solicitação de pull, clique no Copilot ícone no campo "Adicionar uma descrição" e clique em Resumo.

          Copilot examinará a solicitação de pull e fornecerá uma visão geral das alterações feitas em prosa, além de uma lista de alterações com marcadores, indicando os arquivos que elas afetam.

Verifique se você está satisfeito com a descrição de Copilot.
Quando os revisores chegarem à pull request, terão todo o contexto necessário para deixar uma revisão.

Usar Copilot como assistente de revisão

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

Use Copilot para entender as alterações na solicitação de pull.
- Solicite que Copilot resuma as alterações feitas em um arquivo, especialmente útil para casos de diffs mais extensos. Você pode escolher um arquivo específico do diff clicando no canto superior direito do arquivo.
- Para alterações em linhas específicas, realce as linhas que você deseja entender melhor e, em seguida, peça para 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 em sua revisão de PR** com Copilot. Não se esqueça de anexar as diferenças de arquivo específicas à conversa antes de solicitar Copilot.
```
- Você pode solicitar ao Copilot a opinião dele sobre as alterações do PR perguntando: Provide your judgement as a PR Reviewer, both for functional and non-functional aspects that these changes bring. Observe como esse prompt solicita considerar os aspectos Copilot funcionais e não funcionais do código.
- Para seus próprios comentários de revisão de PR, peça a Copilot uma segunda opinião: 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 Copilot para redigir e refinar seus comentários de revisão.
- Depois de planejar a revisão com Copilot, você pode solicitar uma lista dos comentários que deve fornecer: 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 Copilot para criar um primeiro rascunho de um comentário de revisão que 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 Copilot como revisor

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

O uso da Copilot revisão de código 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 Copilot a revisão de código antes de abrir uma solicitação de pull.

          Os **administradores** devem configurar conjuntos de regras do repositório ou da organização para adicionar Copilot automaticamente como revisor em qualquer solicitação de pull direcionada a ramificações protegidas.

Os líderes de equipe devem capturar o estilo e as regras padrão de sua equipe e defini-los como instruções personalizadas para a organização para que Copilot possa aproveitá-los em revisões.
- Verifique se as instruções personalizadas 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, configure as mesmas recomendações nas instruções Copilot em nível de repositório e 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 da solicitação de pull podem acelerar a resolução de comentários de revisão de PR implementando rapidamente correções com a assistência de Copilot.

Para quaisquer comentários de revisão deixados pelo próprio Copilot, confirme a correção proposta diretamente ou edite-a no Espaço de Trabalho do Copilot antes de confirmar.
Para quaisquer comentários de revisão deixados por pares, navegue até a diferença de arquivo relacionada ao comentário de revisão de PR e anexe a diferença a uma conversa Bate-papo do Copilot. Em seguida, copie o comentário de revisão com um prompt como este: Suggest a fix for this review comment:
Se você estiver usando o VS Code, peça GitHub Copilot no modo de agente para implementar as alterações necessárias do comentário de revisão.

Práticas recomendadas para desenvolvedores

Os desenvolvedores devem:

Solicite a revisão de Copilot no seu IDE antes de fazer push para identificar e resolver problemas antecipadamente.
Use Copilot para planejar e refinar seus próprios comentários de revisão de PR para ajudar os autores de PR a entenderem e resolverem problemas.
Anexe o contexto de diferenciação relevante, incluindo linhas de código específicas, às suas conversas com Copilot.

Os desenvolvedores não devem:

Aplique as sugestões de Copilot sem realizar testes.
Dependa apenas de Copilot para as revisões.
Negligenciar a legibilidade do código.

Recursos

Métricas a observar

Para avaliar 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. Recomendamos considerar as principais zonas de qualidade, velocidade e felicidade dos desenvolvedores e como essas zonas se reúnem para contribuir com os resultados dos negócios.

Aqui estão algumas métricas para avaliar o impacto de Copilot sobre essa meta específica.

Satisfação do desenvolvedor: use pesquisas de desenvolvedor para medir a satisfação com as ferramentas de engenharia.
Pull requests merged per developer: você pode usar o webhook pull request, garantindo que action seja closed e a propriedade merged dentro do objeto pull request seja true.

          **Prazo de entrega de solicitações de pull**: meça o tempo médio entre a criação e a mesclagem de PR.

          **Taxa de escape de defeitos de solicitação de pull**: meça a taxa de problemas de implantação causados por PRs mal revisadas.

          **Tipo de comentário de revisão da solicitação de pull**: baixe comentários de revisão da PR, classifique usando a classificação de tópicos baseada em IA e acompanhe os comentários feitos por revisores humanos sobre design, escalabilidade e estratégia.