Aprimorando a qualidade do código do repositório

Introdução

Este tutorial orienta você a analisar GitHub Code Quality , priorizar e corrigir problemas de integridade do código em seu repositório, ajudando você a reduzir sistematicamente a dívida técnica, melhorar a confiabilidade e a manutenção e comunicar seu impacto aos stakeholders.

Pré-requisitos

•         Code Quality está habilitado para seu repositório. Confira [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality).
  

• Se você estiver habilitando GitHub Code Quality pela primeira vez, verifique se esperou alguns minutos após a habilitação para que uma análise completa CodeQL do branch padrão seja concluída.

1. Avaliar a integridade geral do código do repositório

1. Navegue até a Security and quality aba do seu repositório e, em seguida, em " Qualidade do código", clique em Descobertas padrão.

2. A visão geral no painel de controle "Descobertas padrão" fornece uma avaliação imediata do estado do seu branch padrão hoje:

   •      **A classificação de manutenção** reflete a presença e a gravidade dos achados para código morto, duplicação, complexidade, documentação ausente e falha ao seguir as práticas recomendadas.
     

   •      **A classificação de confiabilidade** reflete a presença e a gravidade das descobertas para correção, desempenho, tratamento de erros, simultaneidade e acessibilidade do código.
     

   

2. Identificar e priorizar as descobertas mais impactantes

Na visão "Descobertas padrão", você verá a lista de resultados da última varredura realizada por Code Quality no branch padrão do repositório. Essas descobertas são:

• Agrupado por regra, para que você possa ver quais tipos de problema afetam mais sua base de código.
• Atribuído um nível de severidade ("Erro", "Aviso", "Observação").

Foco nos achados de alta severidade

Use os filtros de painel para se concentrar primeiro nos resultados de severidade mais alta ("Erros") e examinar quais regras geram mais problemas.

Para melhorar a classificação de confiabilidade ou manutenção do repositório, você deve resolver (corrigir ou descartar) todas as descobertas com o nível de severidade mais alto para essa métrica.

Por exemplo, para melhorar a métrica de "Confiabilidade" do repositório de Precisa de melhorias para Razoável, você precisaria abordar e resolver todas as descobertas de nível de erro que impactam a confiabilidade. Se você tiver uma ou mais descobertas no nível de erro, sua classificação não poderá ser maior do que "Precisa melhorar". Confira Referência de métricas e classificações.

3. Investigar um grupo de descobertas e entender o contexto

Depois de identificar uma regra com vários resultados que deseja abordar, você pode investigar mais para entender os problemas subjacentes.

1. Clique no nome da regra para acessar uma exibição detalhada de todos os resultados dessa regra.

   

2. Clique em Mostrar mais e, em seguida, examine a explicação da regra, qual é a correção recomendada, dando suporte a exemplos de código e referências.

   

4. Escolha as opções de correção

Avalie todos os achados realçados quanto à validade, ao impacto e ao risco. Para melhorar sua classificação de qualidade, você precisa resolver cada descoberta optando por corrigi-la ou descartá-la.

Gerar uma correção automática

Se a conclusão parecer válida e relevante para sua base de código, você poderá gerar uma correção sugerida.

1. À direita de um achado individual, clique em Gerar correção.

2. Analise cuidadosamente o diff da alteração proposta e, se você concordar com ela, clique em Abrir pull request.

3. Na caixa de diálogo "Confirmar correção automática da ramificação", selecione "Abrir uma solicitação de pull" e clique em Confirmar alteração.

   Dica

   No momento, não é possível gerar correções automáticas para um grupo de descobertas em lote.

   Se você quiser abordar várias descobertas com uma única solicitação de pull, repita as etapas 1 e 2 acima e, na caixa de diálogo "Confirmar autofixo no branch", use o nome do branch que você já criou para o primeiro autofixo e selecione "Abrir solicitação de pull" e Confirmar alteração.

   A correção será adicionada à solicitação de pull de rascunho existente da ramificação.

4. Quando estiver pronto, altere o status da solicitação de pull de "Rascunho" para "Pronto para revisão" e examine cuidadosamente as alterações propostas. Aguarde até que as verificações de CI e os testes automatizados sejam concluídos e aprovados antes de mesclar a solicitação de pull.

Ignorar uma descoberta

Você pode descartar um achado se ele não for relevante ou acionável no contexto de sua base de código. Os motivos comuns para ignorar uma descoberta incluem:

• A descoberta está no código legado que não é mais suportado.
• É uma exceção conhecida para os padrões de codificação da sua equipe.
• É um falso positivo que não representa um risco real de qualidade.

Ignorar alertas irrelevantes mantém suas verificações de qualidade focadas em problemas significativos.

1. Para ignorar um resultado, clique .
2. A descoberta desaparecerá da lista de descobertas abertas. Você ainda pode revisar e reabrir as conclusões ignoradas na guia "Ignoradas", na parte superior da página.

5. Medir o aprimoramento e comunicar o impacto

Após a conclusão do trabalho de correção, retorne ao painel "Descobertas padrão" para examinar as métricas de confiabilidade e manutenção atualizadas.

Ao comunicar seu impacto aos stakeholders, realce:

• Qualquer redução no número de descobertas para "Confiabilidade" ou "Manutenção".
• Qualquer alteração na classificação para as classificações de confiabilidade ou de manutenção.
• Os requisitos que foram atendidos para alcançar a alteração na classificação. Por exemplo, a correção de todos os achados de nível "Aviso" fez com que a classificação mudasse de "Razoável" para "Bom".

Use as melhorias nas classificações de qualidade e a redução no número de descobertas para demonstrar o progresso.

6. Impor padrões de qualidade de código para solicitações de pull

Caso ainda não tenha feito isso, configure os limites de qualidade para solicitações de pull para bloquear as alterações na base de código que reduzirão a integridade da base de código. Confira Definindo limites de qualidade de código para solicitações de pull.

Próximas etapas

• Reduza ainda mais a dívida técnica corrigindo descobertas em arquivos alterados recentemente. Confira Aprimorando a qualidade do código mesclado recentemente com a IA.
• Forneça comentários sobre GitHub Code Quality na discussão da comunidade.