O Code Review (revisão de código) é uma das etapas mais importantes no ciclo de desenvolvimento de software. Não se trata apenas de encontrar erros, mas de compartilhar conhecimento, garantir a manutenibilidade do projeto e manter um padrão de qualidade na equipe.

Neste guia, vamos aprender a realizar uma revisão profissional utilizando as ferramentas nativas do GitHub.

O Cenário: O PR que precisamos revisar Link para o cabeçalho

Imagine que um colega enviou um Pull Request (PR) chamado “Adiciona validação de email”. O código altera uma função simples de cadastro.

Código proposto no PR:

function cadastrarUsuario(usuario) {
  // Código atual
  if (usuario.nome != "") {
    localStorage.setItem("user", usuario.email);
    console.log("Usuário cadastrado!");
  }
}

Passo a Passo: Fazendo a revisão no GitHub Link para o cabeçalho

1. Acesse a aba “Files changed” Link para o cabeçalho

Ao abrir o PR no GitHub, não fique apenas na aba Conversation. Vá direto para a aba Files changed. É aqui que a mágica acontece.

2. Comentando linha a linha Link para o cabeçalho

Em vez de comentar no final do PR, comente diretamente no código. Passe o mouse sobre o número da linha que deseja comentar e clique no ícone de "+" (plus) que aparecerá.

Exemplo de comentário sugerido:

“Olá! Notei que estamos salvando apenas o email no localStorage. Seria melhor salvar o objeto usuario completo ou usar um padrão de nomes de chave mais específico, como ‘app_user_data’?”

3. Sugerindo alterações (Suggested Changes) Link para o cabeçalho

O GitHub tem um recurso incrível chamado “Suggest changes”. Se você sabe exatamente como corrigir, você pode escrever o código sugerido e o autor pode aplicar com um clique.

  • No seu comentário, clique no ícone de “Add suggestion” (parece um bloco de código com um “+” dentro).

  • Substitua o trecho antigo pelo novo dentro da caixa que aparecer.

4. Categorizando sua revisão Link para o cabeçalho

Após comentar todas as linhas, clique no botão “Review changes” no canto superior direito. Você terá três opções:

  • Comment: Envie apenas comentários gerais sem alterar o status do PR.

  • Approve: Você autoriza o merge. O código está bom e segue as regras.

  • Request changes: O PR precisa de alterações obrigatórias antes de ser aceito. Use isso quando encontrar bugs ou erros de lógica.

Dicas de Ouro para um Code Review Educado Link para o cabeçalho

Para manter um ambiente saudável, siga estas diretrizes:

  1. Seja gentil: Use frases como “O que você acha de…” ou “Poderíamos considerar…” em vez de ordens diretas como “Mude isso”.

  2. Foque no código, não na pessoa: Diga “Esta lógica pode gerar um bug” em vez de “Você escreveu um código com bug”.

3. Explique o “porquê”: Sempre que pedir uma mudança, explique a razão (ex: performance, segurança ou legibilidade). Isso transforma a revisão em um momento de aprendizado.

4. Elogie: Se encontrar um trecho de código bem escrito, comente elogiando! Isso motiva os desenvolvedores.

Como o autor finaliza? Link para o cabeçalho

Após você solicitar mudanças (Request changes):

  1. O autor corrige o código no computador dele e faz o push para o mesmo branch.

  2. O GitHub atualiza o PR automaticamente.

  3. Você revisa apenas o que foi alterado.

  4. Se estiver tudo certo, você clica novamente em Review changes e seleciona Approve.

Pronto! Agora o dono do repositório ou o autor pode clicar no botão verde Merge pull request.

Seguindo esse fluxo, você garante que seu time entregue códigos mais robustos, evita a introdução de falhas e, principalmente, cria um ambiente onde todos evoluem juntos.