Code Review

Introdução

A revisão de código é uma prática essencial para garantir a qualidade, segurança e consistência do código produzido pela equipe de desenvolvimento. Consiste em uma avaliação sistemática e colaborativa do código-fonte por outros membros da equipe, com o objetivo de encontrar erros, melhorar a qualidade e garantir que o código esteja alinhado com os padrões e boas práticas estabelecidos pela SETIC.

Objetivos da Revisão de Código

Identificar Problemas de Qualidade de Código: A revisão de código ajuda a encontrar erros de sintaxe, bugs, problemas de lógica e outras questões que podem afetar a qualidade e funcionalidade do software.

Garantir Conformidade com Padrões e Boas Práticas: A revisão de código assegura que o código siga as diretrizes e padrões definidos pela empresa, facilitando a manutenção e colaboração entre desenvolvedores.

Melhorar Compreensão e Colaboração: Os revisores têm a oportunidade de entender melhor o código e oferecer feedback construtivo, promovendo o compartilhamento de conhecimento e a melhoria da equipe como um todo.

Otimização e Performance: A revisão de código permite identificar oportunidades para otimizar o código, melhorar o desempenho e reduzir a complexidade.

Responsabilidades dos Participantes

Autor do Código

Submeter o Código para Revisão: O autor deve submeter o código para revisão assim que a funcionalidade estiver completa e antes de ser integrada à branche de development ou production no caso de um hotfix.

Incluir Descrição Concisa da Alteração: O autor deve fornecer um resumo claro e conciso da alteração incluída no código para auxiliar os revisores a entenderem o contexto.

Estar Disponível para Esclarecimentos: O autor deve estar disponível para responder perguntas e esclarecer dúvidas dos revisores durante o processo de revisão.

Revisor

Revisão Diligente e Construtiva: O revisor deve realizar a revisão de código de forma diligente, buscando erros, problemas e oportunidades de melhoria.

Feedback Respeitoso: Os revisores devem fornecer feedback construtivo e respeitoso ao autor, destacando tanto os pontos positivos quanto as áreas de melhoria.

Conformidade com Padrões: Os revisores devem assegurar que o código revisado esteja em conformidade com os padrões e boas práticas definidos pela SETIC.

Líder Técnico

Coordenar o Processo de Revisão: O líder de equipe é responsável por coordenar e facilitar o processo de revisão de código dentro da equipe.

Garantir a Revisão Antes da Integração: O líder de equipe deve assegurar que todas as mudanças de código tenham sido devidamente revisadas antes de serem integradas à branch de destino.

Melhores Práticas de Revisão de Código

Foco na Lógica e Funcionalidade

Verifique a Lógica do Código: Certifique-se de que a lógica do código está correta, cumprindo os requisitos funcionais e atendendo às expectativas do cliente.

Teste as Funcionalidades: Teste as funcionalidades do código revisado para garantir que elas estejam funcionando conforme o esperado.

Adesão aos Padrões de Codificação

Convenções e Padrões de Codificação: Verifique se o código está seguindo as convenções e padrões estabelecidos, incluindo nomenclatura de variáveis, formatação, indentação e organização do código.

Padrões Arquiteturais: Certifique-se de que o código esteja aderindo aos padrões arquiteturais definidos para o projeto.

Tratamento de Erros e Exceções

Tratamento Adequado de Erros: Verifique se o código trata adequadamente os erros e exceções, fornecendo mensagens de erro úteis e tratamentos apropriados.

Segurança: Certifique-se de que o código não exiba informações sensíveis em mensagens de erro que possam ajudar a atacantes.

Testes Automatizados

Cobertura de Testes: Confirme que o código inclui testes automatizados para cobrir cenários funcionais e de borda relevantes.

Testes de Unidade e Integração: Verifique se os testes cobrem adequadamente as diferentes camadas da aplicação (testes de unidade, integração etc.).

Comentários e Documentação

Comentários Descritivos: Verifique se o código está adequadamente documentado, com comentários relevantes explicando decisões de design e lógica complexa.

Documentação do Código Público: Garanta que o código público (bibliotecas, APIs, etc.) esteja adequadamente documentado para facilitar seu uso por outros desenvolvedores.

Revisão de Código no GitLab

Os membros da equipe designados como revisores receberão notificações sobre os MRs criados e são responsáveis por revisar as alterações.

Os revisores podem aprovar o MR quando estiverem satisfeitos com as alterações ou podem adicionar comentários solicitando alterações ou fornecendo sugestões de melhoria.

Durante o processo de revisão, os revisores podem utilizar a funcionalidade de "Revisão Dif" do GitLab para alternar entre as diferentes versões do MR e visualizar todas as alterações propostas.

Uma vez que todos os problemas identificados durante a revisão forem resolvidos e o MR for aprovado, ele pode ser mesclado (merged) no branch de destino, incorporando as alterações ao código principal.