Seções de code review

Olá Carla, tudo certinho?

As sessões de code review são momentos importantes para garantir a qualidade do código e promover a colaboração dentro da equipe. Elas envolvem a revisão do código escrito por um desenvolvedor por outros membros da equipe, com o objetivo de identificar possíveis melhorias, erros e garantir que as melhores práticas estão sendo seguidas.

A sessão pode ser adaptada para que se adeque perfeitamente à cada equipe. Aqui abaixo deixo alguns passos que podem ser seguidos como esqueleto do code review:

1. Preparação: Antes da sessão, o autor do código deve garantir que o código está bem documentado e que todas as mudanças estão claramente explicadas. Isso inclui comentários no código e uma descrição detalhada no pull request.

2. Definir Objetivos: Estabeleça o que você espera alcançar com a revisão. Isso pode incluir a detecção de bugs, a melhoria da legibilidade do código, a verificação de aderência aos padrões de codificação, entre outros.

3. Revisão em Pequenas Partes: É mais eficaz revisar pequenas partes do código de cada vez. Revisões muito grandes podem ser cansativas e menos produtivas.

4. Utilizar Ferramentas de Code Review: Ferramentas como GitHub, GitLab, Bitbucket, entre outras, facilitam o processo de revisão, permitindo comentários linha a linha e discussões em tempo real.

5. Foco na Construção e Não na Crítica: O objetivo é melhorar o código e ajudar o autor a crescer. Portanto, mantenha um tom construtivo e evite críticas pessoais.

6. Sessões Abertas: Como mencionado no material do curso, realizar sessões de code review abertas pode ser muito benéfico. Isso permite que membros de diferentes equipes participem e entendam as decisões técnicas, promovendo a transparência e a compreensão mútua.

7. Feedback Construtivo: Dê feedback específico e construtivo. Em vez de apenas apontar um problema, sugira soluções ou melhorias.

8. Documentação e Exemplos: Utilize a documentação técnica, fluxogramas e exemplos práticos para explicar melhor as mudanças e facilitar a compreensão.

Por exemplo, se você está revisando uma função que faz uma consulta ao banco de dados, pode ser útil incluir um diagrama que mostre como essa função se encaixa no fluxo geral do sistema.

Alguns conteúdos da Alura que podem ser interessantes para complementar:

• Podcast: pull requests e code review
• Aula "A rotina da gestão tech"
• Formação desenvolvimento seguro - para uma visão técnica sobre segurança no desenvolvimento

Espero ter ajudado.

Abraços!

boa noite Lariissa tudo bem explicado.

Excelente contribuição.