Code review é uma prática de revisão de código muito utilizada em projetos open-source ou em projetos empresariais. Ela consiste em os membros do time revisarem o código de um colega antes de integrá-lo à base de código.
Pull request é quando você envia uma sugestão de melhoria para o repositório.
- Ao criar um PR certifique-se se ele segue a seguinte descrição:
- Funcionalidade: {funcionalidade que você está adicionando}
- Descrição: {curta descrição do que foi feito}
- Dependências:
- {lista de novas dependências e suas justificativas}
- Testar localmente e garantir que a aplicação está executando normalmente
- Verificar você mesmo o código em busca de falhas de padronização e erros
- Git
- Todos os commits são pequenos e divididos logicamente
- Os commits têm mensagens curtas e descritivas
- O commit está livre de arquivos de IDE/editor e afins
Itens que você deve checar antes de abrir o PR ou ao revisar o PR de outro membro
- O código está funcionando?
- O layout ou especificação está de acordo com o definido?
- Você testou o que desenvolveu?
- Você verificou se não quebrou outra parte da aplicação?
- O seu código está seguindo os padrões de organização do projeto?
- O código está repetitivo?
- O nome de variáveis, funções, arquivos, classes, métodos... está de acordo com os padrões de projeto?
- Você está separando as responsabilidades do código de maneira adequada?
- A branch do PR está sincronizada com a de destino e livre de conflitos?
- Certifique-se que você está evitando valores "hardcoded" e está separando os valores em arquivos para constantes, strings...
- Você está evitando ternários e blocos muito longos de
if/else?
- Adiciona comentários quando necessário, descrevendo o porquê?
- Seu código está livre de itens para depuração, como logs desnecessários?
- O código está formatado de acordo com as diretrizes do projeto?
- Segurança
- Usabilidade