<aside> 💡 Dica do Notion: Este modelo documenta fazer revisões de códigos (code reviews). Ele pode ser útil para informar e alinhar novos colaboradores ou quem trabalha de forma remota.

</aside>

Objetivos

Por que precisamos de code reviews? Quais são os princípios norteadores para estas revisões?

Talvez você queira mencionar outras páginas aqui, como as Diretrizes de Engenharia. Para criar um link para outras páginas é só digitar @ seguido do nome da página: Diretrizes de Engenharia

Preparando código para revisão

Esta preparação ajuda seus revisores a completar uma code review com sucesso.

Mensagens de commits

Tente ser o mais descritivo possível ao adicionar mensagens de commits.

Descrições dos pull requests no Github

As descrições dos pull requests devem ser uma versão estendida das mensagens de commit. Escreva sobre o que o commit muda e como você implementou essa mudança.

Revisando códigos

Como revisar

• Sempre olhe duas vezes o pull request, especialmente se ele é importante
  • Da primeira vez, procure entender a mudança feita em um nível geral;
  • Da segunda vez, preste mais atenção aos detalhes semânticos.

Exemplos

var commentCount = 0;

Você pode fazer a sugestão de que este var seja substituído por let.