Como fazemos revisões de código

Temos orgulho de superar as expectativas dos clientes com aplicativos web e móveis avançados que os usuários adoram. Revisões completas de código são uma parte importante de como fazemos isso, pois permitem verificar que escrevemos código bem estruturado e fácil de manter.

Embora pratiquemos integração contínua e executemos testes automáticos regularmente, a revisão humana continua sendo fundamental para garantir que o código tenha alta qualidade e funcione bem. Por isso, as revisões de código fazem parte do nosso processo de desenvolvimento na sophilabs. Não integramos código novo à branch principal de desenvolvimento até que pelo menos outro integrante da equipe o tenha revisado e tenhamos feito as alterações necessárias. Neste post, explicaremos nossa abordagem e percorreremos o processo passo a passo.

Primeiro passo: criar uma solicitação de integração

Quando um dos nossos desenvolvedores termina de escrever o código de uma funcionalidade, cria um pull request se usa GitHub ou um merge request se usa GitLab, e atribui esse código a um colega para revisão.

O ideal é pedir a revisão ao colega que escreveu a versão original do código daquela funcionalidade. Quando isso não é possível, a revisão pode ser atribuída a alguém da equipe que conheça bem a linguagem de programação em questão.

Se a solução envolver duas linguagens de programação, o desenvolvedor poderá escolher mais de um revisor conforme os conhecimentos e as habilidades dos colegas. Também pode pedir a mais de uma pessoa para revisar seu trabalho se a funcionalidade for especialmente crítica para o software ou se as mudanças forem importantes ou complexas.

Segundo passo: receber comentários

Nessa fase, o revisor examina o trabalho do colega, observando todas as alterações com atenção. Além de verificar se o código está correto, testa a funcionalidade para conferir se ela realmente funciona como esperado.

GitHub e GitLab permitem deixar comentários escritos onde o revisor detectar um problema. O desenvolvedor pode responder a esses comentários se tiver dúvidas. Os dois também podem se reunir rapidamente em pessoa quando houver questões complexas que sejam mais fáceis de explicar em uma conversa.

Na sophilabs, nossa regra é focar no trabalho, e não na pessoa, especialmente ao dar comentários construtivos. Também percebemos que, quanto mais específico o revisor for, mais úteis serão seus comentários para o desenvolvedor.

Terceiro passo: fazer alterações e revisar

Nessa fase, o desenvolvedor melhora o código. Depois, o revisor o examina novamente e aprova as alterações ou traz mais comentários se ainda houver pontos a ajustar. Esse processo colaborativo pode ter várias rodadas, até que o código esteja em excelentes condições e o revisor aprove o pull request.

Nossos padrões de código são rigorosos, e o esforço conjunto durante a revisão melhora sua qualidade. Também trabalhamos em equipe, então frequentemente nos oferecemos para ajudar a implementar mudanças, especialmente quando um problema é complicado.

Quarto passo: integrar o código

A última etapa é integrar o código à branch principal de desenvolvimento. Na sophilabs, assumimos a responsabilidade pelo nosso trabalho: embora recebamos ajuda e comentários dos colegas, consideramos que o bom funcionamento das nossas contribuições individuais ao software é, em última instância, nossa responsabilidade pessoal.

Criar software de alta qualidade é uma tarefa complexa. Incluir revisões de código como parte obrigatória do processo de desenvolvimento é uma das formas de garantir que criamos um excelente produto. Acreditamos que perspectivas diversas melhoram as soluções e cobramos uns dos outros o nosso melhor trabalho.

Na sophilabs, nosso principal propósito é desenvolver software que atenda às necessidades dos clientes, por isso criamos práticas que garantam seu sucesso. Se quiser saber mais sobre como trabalhamos, consulte nosso processo de desenvolvimento.