Diretrizes de revisão de código para melhor qualidade de código

Como todos nós sabemos, não há regras certas quando se trata de revisão de código. Da minha experiência, deduzi os pontos mencionados abaixo para melhorar a qualidade do código antes do envio de PR/MR.

• Siga os padrões PSR para nomenclatura (https://www.php-fig.org/psr/);
• Use práticas de código limpo para escrever um pedaço de lógica ( https://github.com/jupeter/clean-code-php);
• Regras para declarar uma função/método:
  • Pequeno (não mais que 20 linhas);
  • Faça uma coisa específica;
  • Use nomes descritivos conforme PSR;
  • Prefira menos argumentos.
• Regras para Comentários
  • Tente sempre se explicar em código, não em comentários;
  • Não seja redundante;
  • Não adicione ruído óbvio;
  • Não comente o código. Apenas remova. Se for um pedaço de código funcional, por favor, escreva um comentário apropriado de que isso está funcionando;
  • Use como explicação de intenção;
  • Use como esclarecimento de código;
  • Use como aviso de consequências.
• Declare variáveis próximas ao seu uso;
• Funções dependentes devem ser próximas;
• Funções semelhantes devem estar próximas;
• Coloque as funções na direção para baixo, mas se for uma relação, coloque-a no topo do arquivo do modelo;
• Tente sempre pesquisar funções existentes antes de criar uma nova;
• Todas as alterações devem ser feitas via Git. Em nenhuma circunstância o FTP deve ser usado para fazer as alterações necessárias.

#php #laravel #produtividade