# Uso responsável da Qualidade do Código do GitHub

Use GitHub Code Quality com responsabilidade compreendendo suas finalidades, funcionalidades e limitações.

> \[!NOTE]
>
> ```
>           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.
  ```

* <c0>A análise baseada em <c0>LLM (Modelos de Linguagem de Grande Porte)</c0> fornece insights adicionais sobre possíveis preocupações de qualidade além do que é coberto por mecanismos determinísticos como <c1 />. 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 **<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-shield" aria-label="shield" role="img"><path d="M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg> Security and quality** repositório.

Quando um problema de qualidade é detectado por qualquer tipo de análise, **Autofixo do Copilot** 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.

##

```
          Correção Automática 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 Correção Automática do GitHub Copilot, consulte [Uso responsável do Copilot Autofix para escaneamento de código](/pt/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning).

## 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 Autofixo do Copilot 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](/pt/copilot/responsible-use/code-review).

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 Autofixo do Copilot

```
          Autofixo do Copilot 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 Autofixo do Copilot, 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 Autofixo do Copilot cuidadosamente as sugestões antes de aplicá-las.

Para obter mais informações sobre as limitações de Autofixo do Copilot, a qualidade das Autofixo do Copilot sugestões e a melhor maneira de atenuar suas limitações, consulte [Uso responsável do Copilot Autofix para escaneamento de código](/pt/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning)

## Fornecer comentários

Você pode fornecer feedback sobre GitHub Code Quality na [discussão da comunidade](https://github.com/orgs/community/discussions/177488).

## 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](/pt/code-security/code-quality/get-started/quickstart).