Contexto e objetivos

O code review é uma prática essencial para melhorar a qualidade do código, compartilhar conhecimento
entre a equipe e reduzir a incidência de bugs em produção. O objetivo é identificar problemas
cedo, manter consistência de arquitetura e garantir que mudanças sejam compreendidas por quem
as revisa e por quem as receberá.

Esta leitura foca em técnicas objetivas de revisão, critérios claros de avaliação e como estruturar feedbacks
que agreguem valor sem ruídos.

Pré-requisitos da revisão

• Definição clara do objetivo do PR (correção de bug, melhoria de desempenho, refatoração, etc.).
• Checkout de código atualizado, testes locais passando e linting estável.
• Descrição objetiva no PR: contexto, impacto, mudanças e casos de uso relevantes.
• Escopo delimitado e tempo de revisão acordado para evitar PRs em excesso.
• Critérios de aceitação e métricas de qualidade atualizados (testes, cobertura, performance quando aplicável).

O objetivo é que o revisador tenha condições de avaliar sem precisar reinventar decisões ou mergulho excessivo no código.

Práticas para revisão eficiente

1. Filtro inicial: leia o objetivo do PR e o impacto esperado antes de abrir o código.
2. Exame de alto nível: verifique arquitetura, padrões de design, nomes de funções/classes e responsabilidades.
3. Avaliação do código: legibilidade, clareza de intentos, separação de responsabilidades, duplicação e dependências.
4. Feedback objetivo: ofereça sugestões claras e, se possível, um caminho de resolução.
5. Validação de testes: confirme que cenários relevantes estão cobertos, incluindo edge cases e falhas esperadas.

Exemplo prático

// Exemplo: função de fetch com validação de entrada e tratamento de erro
async function getUserProfile(user) {
  if (typeof user !== 'string' && typeof user !== 'number') {
    throw new TypeError('user deve ser string|number');
  }
  const id = String(user);
  const res = await fetch(`/api/users/${encodeURIComponent(id)}`);
  if (!res.ok) {
    throw new Error(`Falha ao buscar usuário: ${res.status}`);
  }
  const data = await res.json();
  // validação de schema poderia ocorrer aqui
  return data;
}

Pontos a observar no código acima:

• Valide entradas para evitar comportamentos inesperados.
• Utilize encodeURIComponent para URLs dinâmicas.
• Tratamento de erros explícito evita falhas silenciosas.
• Considere validação de schema nos dados retornados conforme o contexto da aplicação.

Comunicação, feedback e follow-up

• Seja específico: descreva o que precisa ser alterado, por que é necessário e como resolver.
• Foque em cooperação: prefira perguntas e sugestões do que ordens diretas.
• Priorize mudanças críticas (segurança, estabilidade, leitura de dados) e sinalize padrões para futuras revisões.
• Registre decisões importantes e links para guidelines ou padrões internos.
• Verifique as mudanças após a correção: re-run de testes e validação manual, se aplicável.