Observação
GitHub Code Quality está atualmente em versão prévia pública e sujeito a alterações.
Durante versão prévia pública, Code Quality não será cobrado, embora as verificações Code Quality consumam GitHub Actions minutos.
Sobre o GitHub Code Quality
GitHub Code Quality ajuda os usuários a melhorar a confiabilidade do código, a manutenibilidade e a integridade geral do projeto, fornecendo feedback acionável e oferecendo as correções automáticas para quaisquer achados em solicitações de pull e na ramificação padrão.
Quando você habilitar Code Quality, dois tipos de análise são executados:
-
** CodeQL as consultas de verificação de qualidade são** executadas usando code scanning a análise para identificar problemas com a manutenibilidade, confiabilidade ou estilo de código. Isso é executado em código alterado em todas as solicitações de pull direcionadas à ramificação padrão. Ele também é executado periodicamente na ramificação padrão completa. -
A análise baseada em LLM (Modelos de Linguagem de Grande Porte) fornece insights adicionais sobre possíveis preocupações de qualidade além do que é coberto por mecanismos determinísticos como. Isso é executado automaticamente nos arquivos alterados nos envios recentes para a ramificação padrão. Essas descobertas são exibidas no Code Qualitypainel na aba Descobertas de IA do Security and quality repositório.
Quando um problema de qualidade é detectado por qualquer tipo de análise, Copilot Autofix sugere uma correção relevante que pode ser revisada e aplicada pelos desenvolvedores.
Em solicitações de pull, Code Quality os resultados são exibidos como comentários deixados pelo bot github-code-quality, inclui uma correção automática sugerida sempre que possível.
Análise baseada em LLM para envios recentes
Após cada push para o branch padrão, a LLM analisa arquivos alterados recentemente para questões de manutenção, confiabilidade e outras questões de qualidade. Code Quality inspeciona seu código e fornece comentários usando uma combinação de processamento de linguagem natural e aprendizado de máquina.
Processamento de entrada
As alterações de código são combinadas com outras informações contextuais relevantes para formar um prompt e esse prompt é enviado para um modelo de linguagem grande.
Análise de modelo de linguagem
O prompt é então passado pelo modelo de linguagem Copilot, que é uma rede neural treinada em um grande corpo de dados de texto. O modelo de linguagem analisa o prompt de entrada.
Geração de resposta
O modelo de linguagem gera uma resposta com base na análise do prompt de entrada. Essa resposta pode assumir a forma de sugestões de linguagem natural e sugestões de código.
Formatação de saída
A resposta gerada pelo Code Quality é apresentada diretamente ao usuário, fornecendo comentários de código vinculados a linhas específicas de arquivos específicos. Onde Code Quality forneceu uma sugestão de código, a sugestão é apresentada como uma alteração sugerida, que pode ser aplicada com alguns cliques.
Autofixo do GitHub Copilot Sugestões
Em solicitações de pull, Code Quality os resultados encontrados pela code scanning análise enviam entrada para o LLM. Se a LLM puder gerar uma correção em potencial, o github-code-quality bot postará um comentário com uma alteração sugerida diretamente na solicitação de pull.
Além disso, os usuários podem solicitar a geração de correções automáticas para os resultados na ramificação padrão.
Para obter mais informações sobre o processo de geração de sugestões para Autofixo do GitHub Copilot, consulte Uso responsável da Correção Automática do Copilot para verificação de código.
Caso de uso para GitHub Code Quality
O objetivo de GitHub Code Quality é:
- Identifique problemas de qualidade do código em todo o seu repositório, para que os desenvolvedores e administradores do repositório possam identificar, priorizar e relatar rapidamente as áreas de risco.
- Acelere o trabalho de correção ao oferecer Copilot Autofix sugestões de resultados encontrados por verificações da ramificação padrão, bem como para as descobertas em pushes recentes para a ramificação padrão.
- Forneça rapidamente comentários acionáveis sobre o código de um desenvolvedor. Em solicitações pull, Code Quality combina informações sobre práticas recomendadas com detalhes da base de código e descobertas para sugerir uma possível correção para o desenvolvedor.
Melhorando o desempenho de GitHub Code Quality
Se você encontrar algum problema ou limitação nas correções sugeridas nas solicitações de pull, recomendamos que envie seu feedback usando os botões de “curtir” e “não curtir” nos comentários do bot github-code-quality. Isso pode ajudar a melhorar a ferramenta GitHub e a resolver quaisquer preocupações ou limitações.
Limitações de GitHub Code Quality
Limitações da análise do Code Qualityimpulsionada por LLM
Code QualityA análise potenciada por LLM usa o mesmo modelo de linguagem subjacente e o mecanismo de análise que GitHub Copilot revisão de código. Portanto, ele compartilha limitações semelhantes ao analisar a qualidade do código. As principais considerações incluem:
- Detecção incompleta
- Falsos positivos
- Precisão da sugestão de código
- Possíveis desvios
Para obter informações detalhadas sobre essas limitações, consulte Uso responsável da revisão de código do Copilot GitHub.
Você sempre deve examinar as descobertas exibidas pela análise impulsionada pelo LLM de GitHub Code Quality para verificar sua precisão e aplicabilidade à sua base de código.
Limitações de Copilot Autofix
Copilot Autofix para Code Quality descobertas não será capaz de gerar uma correção para cada descoberta em cada situação. O recurso opera com base no melhor esforço e não tem a garantia de ter êxito em 100% das vezes.
Ao examinar uma sugestão de Copilot Autofix, você sempre deve considerar as limitações da IA e editá-las conforme necessário antes de aceitá-las. Você deve sempre examinar e verificar Copilot Autofix cuidadosamente as sugestões antes de aplicá-las.
Para obter mais informações sobre as limitações de Copilot Autofix, a qualidade das Copilot Autofix sugestões e a melhor maneira de atenuar suas limitações, consulte Uso responsável da Correção Automática do Copilot para verificação de código
Fornecer comentários
Você pode fornecer feedback sobre GitHub Code Quality na discussão da comunidade.
Próximas etapas
Veja como GitHub Code Quality funciona em seu branch padrão para identificar problemas de qualidade de código e ajudá-lo a entender rapidamente a saúde do código do repositório. Confira Guia de Início Rápido para Qualidade do Código no GitHub.