Code review educado

Nível: A2

Objetivo

Fazer pedidos educados, aprovar, pedir mudanças e agradecer em um code review em inglês, usando Could you, Please, Looks good, LGTM e NIT em contextos profissionais.

Explicação

Em um code review em inglês, o tom educado é fundamental. Em vez de ordens diretas, use pedidos indiretos e expressões neutras que abrem espaço para diálogo.

Use Could you + verbo na forma base para pedidos educados de mudança: `Could you add a test for this?`, `Could you rename this variable?`. O verbo depois de could não recebe `-s`, mesmo quando o sujeito é `he` ou `she`: `Could you add...`, não `Could you adds...`.

Use Could we + verbo base quando quiser propor uma mudança de forma colaborativa: `Could we use a different name?`, `Could we move this to a separate file?`.

Use Please + verbo base para um pedido firme, mas ainda educado: `Please add a comment here`, `Please check the function on line 12.` Evite o imperativo direto, como `Add a test` ou `Rename this`, que soa abrupto.

Para aprovar o trabalho, três expressões comuns:

• `Looks good.` — simples e direto.
• `Looks good to me.` — confirma que está bom para você.
• `LGTM` (looks good to me) — abreviação muito usada entre engenheiros.

Para elogiar o trabalho, use `Nice work!`, `Great job!`, `Clean solution!`. Combine o elogio com um pedido opcional: `Nice work on the API call! Could you add a test for the empty case?`.

Um NIT (nitpick) é uma observação pequena, que não bloqueia a aprovação. Comece com `NIT:` ou `nit:` e continue com uma sugestão educada: `nit: could you add a space after the comma?`.

Para agradecer a revisão, use `Thanks for the review.`, `Thanks for the feedback.`, `Thanks for catching that.` Catching significa notar ou pegar um problema. Responder rápido a um pedido reduz o tempo de revisão.

Em geral, um comentário educado segue este padrão:

1. Abertura neutra: `Nice work on this!`
2. Pedido ou sugestão: `Could you add a test?`
3. Justificativa curta: `The empty case can break the search.`
4. Fechamento: `Thanks!`

Esse padrão deixa claro o que precisa mudar, mas mantém a conversa respeitosa.

Exemplos

Erros comuns

• Usar o imperativo direto em vez de could you: `Add a test` deve ser `Could you add a test?`.
• Colocar o verbo em -s depois de could: `Could you adds a test?` deve ser `Could you add a test?`.
• Esquecer o `-s` em looks good: `Look good to me` deve ser `Looks good to me.`
• Não agradecer ao final da revisão: um simples `Thanks for the review!` encerra bem a conversa e é esperado em equipes de engenharia.
• Dizer `You forgot to...` ou `This is wrong`: o tom direto soa agressivo. Prefira `Could you add...?` ou `I think we should...`.

Prática guiada

Monte um comentário educado para um code review:

1. Abertura com elogio: `Nice work on the API call!`
2. Pedido educado: `Could you add a test for the empty case?`
3. Razão curta: `The empty case can break the search.`
4. Fechamento: `Thanks!`

Comparação rápida:

• Direto: `Add a test.`
• Educado: `Could you add a test, please?`

• Negativo: `This variable name is bad.`
• Construtivo: `NIT: could you rename this to 'user'?`

Observe como a forma educada preserva o pedido, mas abre espaço para diálogo e reduz o atrito entre revisor e autor.

Resumo

Use Could you + verbo base para pedidos educados, Please + verbo base para pedidos firmes, Looks good / LGTM para aprovar, NIT para pequenas observações não-bloqueantes, e Thanks for the review para encerrar a revisão. Evite o imperativo direto e o tom negativo.

História: Code review educado

Nível: A2

História em inglês

The new pull request

On Tuesday morning, Anna opened a pull request to add a user search feature to the dashboard. The pull request title was 'Add user search to the dashboard'. Brian, a senior engineer, started the review right after his coffee. He read the description and opened the main file.

Friendly comments

Brian left three polite comments on the pull request. First, he wrote: 'Could you add a test for the empty case?' Then he added a NIT: 'nit: could you rename the variable u to user?' Finally, he wrote: 'Looks good overall. Nice work on the API call!'

Approval and thanks

Anna replied: 'Thanks for the review! I will update the code this morning.' She renamed the variable and added a new test. Brian looked at the new changes and approved the pull request. He wrote: 'LGTM. Thanks for catching that so quickly.' Anna merged the change to the main branch and deployed the new feature in the afternoon.

Tradução linha por linha

Notas de vocabulário

• Could you add a test for the empty case? = Pedido educado padrão em code review; could you é seguido por verbo na forma base.
• NIT = Abreviação de nitpick; pequena observação de estilo que não bloqueia a aprovação.
• Looks good overall = Aprovação geral, com espaço para elogios ou comentários específicos em seguida.
• Nice work on the API call = Elogio específico a uma parte do código; abre espaço para o pedido que vem em seguida.
• LGTM = Abreviação de looks good to me; forma comum de aprovar entre engenheiros.
• Thanks for catching that = Agradecimento padrão por notar um problema; catching = notar, perceber.

Perguntas de compreensão

1. What feature did Anna add in her pull request?
2. Who reviewed Anna's pull request?
3. What did Brian ask Anna to add in his first comment?
4. What small thing did Brian mention about the variable name?
5. How did Anna reply after Brian left his comments?
6. What did Brian write when he approved the pull request?
7. What did Anna do after the approval?

Prática com a história

1. Reescreva de forma educada: Add a test for the empty case.
2. Traduza: Pequena observação: você poderia renomear essa variável?
3. Traduza: Aprovado. Obrigado por notar isso.
4. Complete a frase de Anna: 'I will update the code ____ morning.'