Como escrever comentários de code review em inglês
No code review, comentários em inglês costumam ser sugestões em forma de pergunta: "Could we extract this into a helper?" ou "What do you think about renaming this variable?". Para detalhes pequenos, use "nit:"; para aprovar, "LGTM" (looks good to me).
Exemplos
Could we extract this logic into a helper function?
Podemos extrair essa lógica para uma função auxiliar?
sugestão
nit: missing a blank line here.
detalhe: falta uma linha em branco aqui.
detalhe pequeno
Good catch, I'll fix it.
Bem observado, vou corrigir.
respondendo
LGTM, just one minor comment.
Pode aprovar, só um comentário pequeno.
aprovando
Siglas que você vai ver
| Sigla | Significado | Em português |
|---|---|---|
| LGTM | looks good to me | por mim está bom |
| nit | nitpick | detalhe pequeno, não bloqueia |
| PTAL | please take another look | dá outra olhada, por favor |
| WIP | work in progress | ainda em andamento |
| IMO / IMHO | in my (humble) opinion | na minha opinião |
Sugerir sem soar mandão
- "What do you think about…?" — o que acha de…?
- "Could we…?" — podemos…?
- "Have you considered…?" — você pensou em…?
- "Should we add a test for this case?" — vale um teste para este caso?
Respondendo comentários
- "Good catch!" — bem observado!
- "Done." / "Fixed in the latest commit." — feito / corrigido no último commit.
- "I'd rather keep it this way because…" — prefiro manter assim porque…
Erros comuns
You must change this.
Could we change this?
"You must" soa como ordem; em code review o tom é colaborativo.
I did the corrections.
I made the changes.
Com mudanças, o natural é "make changes".
Você entendeu?
Perguntas frequentes
Code review é o mesmo que pull request?
Não. O pull request é o pedido para juntar o código; o code review é a revisão que acontece dentro dele.