Code Review com StackSpot AI

A StackSpot AI te ajuda a analisar seu código rapidamente, trazendo um feedback inicial sobre boas práticas, possíveis vulnerabilidades e oportunidades de melhoria. Assim, você pode corrigir e aprimorar seu código logo após abrir um Pull Request.

Além disso, a StackSpot AI destaca pontos de melhoria, problemas críticos e sugere novas implementações, como testes unitários, por exemplo.

O que o Code Review entrega

O Code Review se baseia na melhores práticas da linguagem, conceitos SOLID, boas práticas de Clean Code e diretrizes de acessibilidade (WCAG). Confira a seguir o que ele pode fazer:

Gerar um changelog completo das alterações feitas no código.
Analisar a acessibilidade conforme as recomendações do WCAG (Web Content Acessibility Guidelines).
Fazer um Code Review de acordo com a sua plataforma, checando pontos como:
- Erros de compilação ou execução e possíveis vulnerabilidades.
- Melhorias de performance.
- Ajustes na sintaxe, formatação e sugestões de boas práticas.

Como adicionar o Code Review

Siga os passos a seguir para usar o Code Review da StackSpot AI:

Passo 1. Faça o download do arquivo .yml da sua respectiva plataforma. O arquivo deve ser nomeado como 0-stackspot-ai-code-analysis.yml;

Passo 2. Salve o arquivo no diretório .github/workflows do seu módulo;

Passo 3. Faça um commit na sua branch e abra um Pull Request;

Pronto, a análise de Code Review da StackSpot AI já estará sendo executada no seu Pull Request.

Arquivos YML de cada plataforma

Para baixar o arquivo, clique em um dos links da linguagem que você precisa:

Como funciona o Changelog que a StackSpot AI gera?

A StackSpot AI cria um Changelog automático como comentário no seu Pull Request. Esse resumo é feito a partir do comando git diff, mostrando tudo o que foi alterado, removido ou adicionado no seu código. Assim, você consegue conferir as mudanças feitas em cada arquivo envolvido no Pull Request.

Como funciona a Análise de Acessibilidade (WCAG) que a StackSpot AI faz?

A StackSpot AI pode funcionar como um Agente de Acessibilidade para analisar as alterações de código baseadas nos critérios de acessibilidade da WCAG (Web Content Accessibility Guidelines). O objetivo é te ajudar a garantir que o código esteja alinhado com os padrões de acessibilidade, proporcionando uma experiência inclusiva para os clientes.

O resultado da análise mostra possíveis problemas classificados por severidade: Alta, Média ou Baixa. Para casos de severidade Alta, recomendamos que você corrija o quanto antes. A StackSpot AI já traz sugestões de correção para ajudar.

Cada problema encontrado é detalhado, informando os detalhes a seguir:

O nome do arquivo;
Número da linha;
O grau de severidade;
E uma descrição do problema.

Como funciona o Code Review com a StackSpot AI?

Ao abrir um Pull Request, a StackSpot AI revisa seu código seguindo boas práticas da linguagem, além de conceitos como SOLID e Clean Code.

As principais validações são baseadas nos seguintes pontos:

Erros de compilação ou execução.
Possíveis vulnerabilidades.
Melhorias de performance.
Melhorias na sintaxe e formatação.
Oportunidades de boas práticas.

Cada validação recebe uma nota (score) com os valores 0, 1 ou 2.

Score 0: nenhum problema encontrado ou está excelente nesse quesito.
Score 1: alguns pontos de atenção ou há pequenas melhorias a fazer.
Score 2: problemas significativos que precisam de correção urgente.

Para cada ponto que recebe Score 1 ou 2, a StackSpot AI sugere melhorias e explica por que cada sugestão é relevante, além de mostrar como aplicar a correção.

No final, seu código recebe uma nota geral, de 0 a 10:

Você começa com nota 10;
Se o score for 1, subtrai 1 ponto. Se o score for 2, subtrai 2 pontos.
A nota mínima para aprovação é 7.

Exemplo:

Erros de compilação ou execução: score 0 ✅
Possíveis vulnerabilidades: score 0 ✅
Melhorias de performance: score 0 ✅
Melhorias na sintaxe e formatação: score 1
Oportunidades de boas práticas: score 1

Nota Final = 10 - 2 = 8 Resultado = APROVADO ✅