Introdução
GitHub Code Quality (versão prévia pública) ajuda a manter seu código confiável e manutenível, destacando descobertas de qualidade de código em pull requests e em seu branch padrão.
Neste tutorial, você aprenderá a identificar e corrigir um problema de qualidade de código em seu branch padrão, contribuindo para a melhora da saúde do código do repositório.
Pré-requisitos
-
GitHub Code Quality deve ser habilitado para seu repositório e você deve ter código em um idioma com suporte. 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.
Verifique os resultados da análise da ramificação padrão
No repositório, vá para a Security and quality guia, clique Qualidade do código na barra lateral esquerda e clique Descobertas padrão para abrir o painel do repositório.
Aqui você verá:
-
Classificações para a confiabilidade e a manutenção da base de código, que ajudam você a entender a integridade do código rapidamente.
-
Uma lista de resultados de todos os problemas de qualidade detectados por uma análise CodeQLimpulsionada no seu branch padrão, que estão agrupados por regra e idioma.
Identificar uma descoberta de alto impacto
Utilize os filtros do painel para identificar um achado de alto nível de severidade ("Erro" ou "Aviso").
Resolver isso terá o maior impacto nas classificações do repositório.
Inspecionar os detalhes da detecção
Clique no próprio nome da regra para ver uma exibição detalhada dos arquivos e linhas de código afetados por essa regra.
Depois de estar no modo de exibição detalhado, clique em Mostrar mais para coletar contexto e entender os resultados.
Gerar um Autofixo do Copilot
À direita de um resultado realçado, clique em Gerar correção.
Examine a correção sugerida e clique em Abrir solicitação de pull.
Mesclar a correção
Examine cuidadosamente a solicitação de pull de rascunho. Se você estiver satisfeito com as alterações propostas e todas as verificações e testes estiverem aprovados, vá em frente e mescle a solicitação de pull.
Observe a alteração das métricas
Retorne ao Code Quality painel ( Security and quality aba, em seguida Qualidade do código, em seguida Descobertas padrão).
Aguarde alguns minutos para que a próxima verificação seja concluída — as verificações Code Quality são executadas automaticamente novamente após cada push para o branch padrão.
Observe a alteração nas métricas na parte superior do painel:
-
O número de descobertas para "Confiabilidade" ou "Manutenção" deve ter diminuído.
-
Suas classificações para "Confiabilidade" ou "Manutenção" podem ter melhorado, se a correção tiver resolvido uma série de descobertas de alto impacto.
Para entender mais sobre como as classificações são calculadas, consulte Referência de métricas e classificações.
Conclusion
Você utilizou Code Quality e Autofixo do Copilot com sucesso para melhorar a integridade do código do seu repositório!
O código íntegro é mais fácil de entender, manter e estender e corrigir problemas de qualidade de código torna sua base de código mais confiável, compatível e acelera o desenvolvimento futuro.
Próximas etapas
- Saiba como GitHub Code Quality funciona em solicitações de pull para impedir que problemas de qualidade de código atinjam seu branch padrão. Confira Corrigindo problemas de qualidade do código antes de mesclar sua solicitação de pull.
- Forneça feedback sobre o GitHub Code Quality na discussão da comunidade.