O que é o relatório de Code Review?
O dashboard de Code Review fornece uma visão abrangente do processo de revisão de código da sua equipe, ajudando a manter alta qualidade de código e melhorar a eficiência das revisões. Através de métricas como revisões completadas, comentários por revisão, profundidade de revisão e tamanho de PR, este dashboard revela o nível de engajamento e minuciosidade nas suas revisões.
Rastreando esses indicadores, as equipes podem identificar áreas de melhoria, promover uma cultura de revisão positiva e garantir feedback consistente e significativo que fortalece a qualidade do código e a colaboração.
Métricas
O dashboard apresenta várias métricas-chave para ajudá-lo a avaliar e aprimorar seu processo de revisão de código:
Reviews Completed
- O quê: O número total de revisões de código completadas dentro do período selecionado. Cada revisão individual conta separadamente. Se múltiplos revisores participam do mesmo pull request, cada uma de suas revisões é incluída no total.
- Por que importa: Esta métrica reflete o nível de engajamento da equipe em revisões de código, essencial para manter a qualidade do código e garantir consistência entre contribuições.
- Como usar: Monitore o volume de revisões ao longo do tempo para avaliar se a equipe está mantendo um ritmo constante de revisão ou se revisões estão sendo despriorizadas em certos períodos. Uma cadência saudável indica colaboração consistente e propriedade compartilhada da qualidade do código.
- Interface:
Comments per Review
- O quê: O número médio de comentários inline deixados por revisão, representando quanto feedback é fornecido diretamente nas linhas de código. (ex: 1,2 comentários por revisão).
- Por que importa: Mais comentários por revisão sugerem revisões mais minuciosas, enquanto números mais baixos podem indicar necessidade de incentivar feedback mais profundo.
- Como usar: Incentive comentários significativos para melhorar a qualidade do código e promover compartilhamento de conhecimento. Use esta métrica para rastrear profundidade de revisão e identificar áreas onde o feedback poderia ser mais abrangente.
- Interface:
PR Size
- O quê: O tamanho médio dos pull requests revisados, medido em linhas de código.
- Por que importa: PRs menores são geralmente mais rápidos de revisar e menos propensos a erros, enquanto PRs maiores podem desacelerar o processo e aumentar a complexidade da revisão.
- Como usar: Incentive contribuidores a dividir mudanças grandes em PRs menores para revisões mais rápidas. Rastreie o tamanho de PR ao longo do tempo para promover revisões gerenciáveis e de alta qualidade.
- Interface:
Review Depth
- O quê: O número médio de comentários por pull request.
(Isso inclui comentários na discussão do PR, não comentários inline de código.)
- Por que importa: Esta métrica reflete a minuciosidade e qualidade das revisões de código. Um número maior de comentários pode indicar colaboração e feedback mais profundos, enquanto poucos comentários podem sugerir engajamento limitado ou PRs excessivamente simples.
- Como usar: Rastreie mudanças na profundidade de revisão ao longo do tempo para entender a cultura de revisão da sua equipe. Busque um equilíbrio, com comentários suficientes para garantir revisão cuidadosa e entendimento compartilhado, mas não tantos que desacelerem a entrega.
- Interface:
PRs Mergeados sem Revisão
- O quê: O número de pull requests que foram mergeados sem nenhuma revisão ou foram auto-revisados antes do merge. Esta métrica inclui todas as instâncias onde nenhum processo formal de revisão ocorreu antes do merge.
- Por que importa: PRs não revisados podem introduzir riscos de qualidade, reduzir responsabilidade e contornar práticas de colaboração. Monitorar esta métrica ajuda as equipes a garantir que cada mudança de código seja devidamente revisada antes de chegar à produção.
- Como usar: Mantenha este número o mais próximo de zero possível. Uma contagem alta de PRs não revisados pode indicar pressão de tempo, lacunas no processo de revisão ou atribuições de revisores ausentes. Use este insight para reforçar políticas de revisão e manter a integridade da base de código.
- Interface:
Code Review Dashboard
O Code Review Dashboard fornece uma visão geral visual da atividade e indicadores de qualidade de revisão de código da sua equipe. Ele consolida múltiplas métricas — incluindo Reviews Completed, Comments per Review, Review Depth e PR Size — para ajudar as equipes a entender hábitos de revisão, identificar gargalos e manter padrões de qualidade consistentes.
O gráfico de barras mostra quantos pull requests foram revisados ao longo do tempo, enquanto a tabela abaixo lista cada PR com detalhes como revisores, tamanho, profundidade e problemas detectados.
Ao usar filtros:
- Reviews Completed conta pull requests que incluem revisores entre os players selecionados.
- PR Size reflete pull requests que incluem commits dos players selecionados. Se nenhum filtro de player for aplicado, ambos os números representam a atividade completa do squad para o período selecionado.
Este dashboard permite que as equipes monitorem throughput de revisão, engajamento e saúde geral do código — fornecendo uma visão clara de como a qualidade da revisão evolui ao longo do tempo.
O gráfico inclui:-Code Review Completadas (Gráfico de Barras): Exibe o número de revisões de código completadas a cada semana. Esta visualização ajuda a identificar períodos de maior ou menor atividade de revisão, apoiando rastreamento de consistência entre sprints ou releases.
- Detalhes de Pull Request (Tabela): Lista todos os pull requests revisados, incluindo informações-chave como revisores, tamanho de PR, profundidade de revisão e problemas detectados — permitindo análise mais detalhada de qualidade de revisão e distribuição de carga de trabalho.
Filtros
Use o Filtro de Squad para visualizar métricas de Code Review para squads individuais. Se quiser uma visão mais ampla de todas as equipes, selecione o filtro "Todos" para ver a distribuição de todos os squads de uma vez.
O Filtro de Data permite visualizar dados para períodos específicos. Você pode filtrar pelo último mês, trimestre ou 365 dias. Se precisar de controle mais granular, pode filtrar por um intervalo de datas personalizado.
Use o Filtro de Players para focar em membros individuais da equipe ou um grupo específico dentro do seu squad. Você pode selecionar um membro para uma visualização detalhada, um grupo de membros se formam um sub-squad, ou todos os membros para uma visão geral das métricas de Code Review de todo o squad.
Use o Filtro de Repositório para focar em repositórios específicos ou visualizar métricas de code review em todos os repositórios. Este filtro é especialmente útil para examinar práticas e desempenho de revisão dentro de bases de código individuais, particularmente ao trabalhar em múltiplos repositórios. Analisar atividade de code review por repositório permite identificar gargalos, otimizar processos de revisão e manter consistência na qualidade do código em diferentes partes da sua base de código.
Use o Filtro de Tipo de Issue para focar em tipos específicos de issues, como Features, Bugs, Melhorias ou Hotfixes. Este filtro permite rastrear atividade de code review por tipo de issue, fornecendo insights sobre o foco e prioridades da equipe durante o processo de revisão. Monitorar revisões por tipo de issue é particularmente útil para garantir que itens críticos como hotfixes e bugs recebam atenção rápida, ajudando a manter a qualidade do código e estabilidade do produto.
Explore Melhores Práticas
Conclusão
A funcionalidade de Code Review fornece insights valiosos sobre a atividade de revisão da sua equipe, ajudando a melhorar tanto a qualidade do código quanto a colaboração.
Monitorando métricas como Reviews Completed, Comments per Review, PR Size e Problemas Detectados, as equipes podem identificar padrões, refinar suas práticas de revisão e manter um padrão consistente de qualidade em todos os pull requests.