Docs/Primeiros Passos/Guia: Code Quality

Guia: Code Quality

A qualidade de código é crítica para software estável e manutenível. Use essas métricas para avaliar a qualidade de código em toda a sua organização e squads.

Métricas para Monitorar

Change Failure Rate (DORA Metrics)

  • Por que importa: Taxas de falha altas indicam deploys frágeis ou testes inadequados.
  • Como usar: Melhore testes, revisões de código e processos de deploy.

PRs Mergeados sem Revisão (Collaboration Snapshot)

  • Por que importa: PRs não revisados aumentam o risco de defeitos.
  • Como usar: Estabeleça diretrizes rigorosas de revisão e monitore a não conformidade.

Problemas Encontrados em Revisões (Métricas de Code Review)

  • Por que importa: Indica a eficácia das revisões de código em detectar problemas cedo.
  • Como usar: O que um Aumento Significa: Um número maior de problemas encontrados durante revisões pode significar um processo de revisão completo e eficaz, garantindo que problemas potenciais sejam identificados e resolvidos cedo. No entanto, números consistentemente altos também podem indicar problemas mais profundos, como requisitos pouco claros, práticas de codificação apressadas ou testes pré-revisão insuficientes.O que uma Queda Significa:

Uma queda nos problemas encontrados pode sugerir que as revisões estão se tornando menos eficazes, potencialmente devido a revisões apressadas ou superficiais, falta de engajamento ou atenção reduzida aos detalhes. Também pode indicar melhoria na qualidade inicial do código, mas é essencial cruzar com outras métricas (ex: Change Failure Rate) para confirmar esta suposição.

Retrabalho e Refatoração (Métricas de Work Breakdown)

  • Por que importa: Indica quanto esforço é gasto na melhoria ou correção de código existente.
  • Como usar: Equilibre retrabalho e refatoração com desenvolvimento de funcionalidades para manter a qualidade sem desacelerar o progresso.

Resumo

Monitorar a qualidade de código é essencial para manter uma base de código confiável, escalável e eficiente. Rastreando métricas como Problemas Encontrados em Revisões, PR Size e PRs Não Revisados, gestores de engenharia podem obter insights acionáveis sobre a saúde do seu processo de desenvolvimento.

Por exemplo, uma queda consistente nos problemas encontrados durante revisões pode indicar revisões menos completas, sinalizando a necessidade de melhores práticas de revisão ou treinamento aprimorado. Por outro lado, tamanhos de PR altos podem desacelerar revisões e aumentar o risco de introduzir defeitos. Ao abordar esses padrões, você pode garantir que as revisões de código permaneçam um forte portão de qualidade.

O monitoramento eficaz ajuda as equipes a encontrar o equilíbrio certo entre velocidade de entrega e manutenção de altos padrões de qualidade de código, reduzindo riscos de produção e promovendo eficiência de longo prazo da equipe.