FinanceAPIs

Revisão de código: confira 8 dicas para criar sua checklist!

Seja qual for a área profissional, tentar manter a qualidade do serviço e a produtividade da equipe são duas das premissas mais importantes para um bom andamento do negócio. E é claro que o desenvolvimento de software com foco em UI e UX não é diferente.

Neste caso específico, as listas de verificação e revisão de código são essenciais para que os colaboradores saibam o que priorizar e consigam identificar e corrigir erros assim que surgirem.

Mas o que é revisão de código e o que priorizar nas checklists? Continue a leitura e entenda melhor sobre o assunto!

O conceito de revisão de código e sua relação com o checklist

Não se cria um livro antes de ter passado o texto escrito pela revisão de várias pessoas, não é mesmo? O mesmo acontece com um software em desenvolvimento. Uma entrega sem revisão pode mostrar ao cliente inúmeros bugs, incongruências e funções que precisam ser melhoradas, fazendo que com que a confiança com a sua empresa fique estremecida.

Em outras palavras, a revisão de código nada mais é do que designar uma pessoa ou uma equipe para revisar o sistema e identificar falhas ou melhorias antes que a implantação seja realizada.

No entanto, todo este processo precisa seguir uma ordem para que seja executado da melhor forma possível. E é aí que entram as checklists. As listas de verificação de revisão de código, além de evitarem erros simples, verificam em que etapa o trabalho está e ajudam a melhorar o desempenho do desenvolvedor. 

Agora que você entendeu melhor o que são checklists de revisão de código, confira as 8 dicas de como construir as melhores listas de verificação:

1 - Etiqueta para pull requests 

Comece pelo início: a pull request que você solicita está realmente pronta para revisão? Para determinar isso, aqui estão alguns princípios que devem ser aplicados em todas as revisões de código:

  • Frequência: Para tornar as pull requests mais gerenciáveis, envie poucas solicitações, mas com frequência.
  • Tamanho: Se uma solicitação pull for muito grande, será difícil de entender. Neste caso, é preferível dividi-la tanto quanto possível.
  • Documentação adequada: A solicitação pull tem comentários suficientes para facilitar a revisão?
  • Princípio de Responsabilidade Única: o código deve resolver apenas um problema. Se um trecho de código afeta muito o restante do projeto, fica muito difícil de revisar.
  • Se essas condições não forem atendidas, devolva o código ao contribuidor para ser melhorado ou separado em diferentes solicitações pull.

Isso pode parecer difícil à primeira vista. Mas, ao longo de várias semanas, os resultados e a produtividade de sua equipe começarão a mostrar melhoras.

2 - Estilo

Defina algumas regras básicas de estilo para sua equipe e certifique-se de que sejam seguidas. A criação de um estilo de código consistente é essencial para garantir que os futuros desenvolvedores possam entender o código facilmente e trabalhar de forma produtiva.

Algumas regras básicas podem ajudar: 

  • Os nomes das variáveis são razoáveis e capitalizados de forma consistente?
  • Existem comentários em todo o código, conforme necessário?
  • As preferências de formatação são seguidas? 

Para economizar tempo, você pode verificar se essas regras estão sendo seguidas com um linter de código automático. 

E lembre-se: se esses padrões não forem atendidos, pare de verificar o código e devolva-o ao colaborador para que ele faça as alterações necessárias.

3 - Segurança 

Defina padrões de segurança para seu projeto e verifique se eles estão sendo seguidos. As regras a serem verificadas variam de acordo com o projeto e organização, mas algumas das melhores práticas são:

  • Execute seu projeto por meio de soluções de verificação de vulnerabilidade
  • Não codifique credenciais para teste
  • Não divulgue muitas informações em mensagens de erro, pois isso pode facilitar uma invasão
  • Certifique-se de que todas as consultas de banco de dados estejam parametrizadas
  • Não confie cegamente na entrada do usuário ou do cliente - seu cliente ou aplicativo da web pode ter sido modificado. Verificar os parâmetros de URL é sempre uma boa escolha. 

Se você identificar algum problema de segurança durante a revisão de código, pare e fale com o colaborador. Pode ser o sinal de algo mais sério no projeto ou até mesmo falta de treinamento. 

4. Performance

O projeto tem o melhor desempenho possível? Se a resposta for negativa, é possível otimizar alguns processos, como: 

  • Substituir parte do código por uma biblioteca de melhor desempenho ou por uma função nativa da linguagem
  • Remover algum código de depuração ou registro
  • Usar cache quando possível
  • Compactar imagens e recursos adequadamente 

Existem inúmeras ferramentas que podem ajudá-lo a otimizar o desenvolvimento de software. Chrome Lighthouse e DebugBear são dois exemplos muito bons. 

5. Teste

Os testes verificam, de forma automática, se o código executa as funções adequadamente. Ou seja, é parte fundamental do processo de revisão do código. Nesta etapa:

  • Verifique se os testes estão bem documentados para todas as funcionalidades comuns. Se alguma funcionalidade não for coberta pelo teste, documente-a para que ela possa ser inserida. 
  • Certifique-se de que os testes estejam bem isolados para que você possa encontrar o problema rapidamente se um teste falhar.
  • Finalmente, os testes testam o código? Frequentemente, eles afirmam que sim, mas não avaliam realmente a funcionalidade pretendida do aplicativo.

Jest é uma boa opção se você estiver procurando por testes de unidade automatizados. Para testes automatizados de ponta a ponta, tente o Cypress. 

Vale lembrar que nem todos os testes são eficientes e, por isso mesmo, não devem ser vistos como verdade absoluta. 

6. O código realmente funciona?

Se você estiver em uma equipe ágil, o código deve ser verificado de acordo com os critérios fornecidos por seu product manager ou product owner. Se eles não estiverem sendo atendidos, questione o desenvolvedor. 

Outro problema comum é que o código funciona localmente, mas não na produção. Todo código em revisão deve ser implantado em um ambiente de preparação consistente ao ambiente de produção para evitar possíveis problemas

7. Críticas positivas 

Antes de enviar seu feedback de revisão de código ou se sentar para uma reunião, verifique se seus comentários ajudarão sua equipe a melhorar, em vez de serem vistos apenas como críticas.

As revisões de código são uma das interações mais frequentes que ocorrem com o restante da equipe. Vale gastar um tempo para reformular os feedbacks críticos com declarações construtivas. 

8. Revisão constante de checklist 

Sua checklist só será válida se estiver atualizada. É por isso que é importante revisá-la continuamente para garantir que ela continua atendendo as necessidades.

As etapas de revisão de código mudarão conforme novos membros da equipe se juntem ou seu projeto ganhe novos requisitos. 

E lembre-se também que estas são apenas algumas dicas de como manter o desenvolvimento de UI / UX produtivo e com qualidade, mas vale a pena pesquisar outros que também sejam úteis para sua equipe.

Continue lendo os Trends da GR1D Finance!