Ingles para Code Review
Por que Code Review precisa de ingles especial
Seção intitulada “Por que Code Review precisa de ingles especial”Code review nao e simplesmente feedback tecnico — e comunicacao de equipe. Escolha errada de palavras pode:
- Parecer arrogante ou sarcastico
- Prejudicar a motivacao dos colegas
- Causar mal-entendidos (especialmente em equipes multiculturais)
- Fazer parecer que voce esta “implicando” em vez de ajudando genuinamente
A boa noticia e: existe um conjunto padrao de expressoes que todos entendem.
10 Expressoes Essenciais para Code Review
Seção intitulada “10 Expressoes Essenciais para Code Review”1. Nit (problema pequeno)
Seção intitulada “1. Nit (problema pequeno)”“Nit” vem de “nitpick” (implicar com detalhes), mas em code review e um termo positivo, significando “isso e pequeno, nao afeta o quadro geral, mas vale melhorar”.
"This variable name is bad""Nit: could we rename this to `userCount`?""Minor: I'd prefer `userCount` for clarity"Quando usar:
- Problemas de nomenclatura, formatacao, estilo
- Sugestoes de refatoracao (nao obrigatorias mas melhores)
- Complemento de documentacao
2. LGTM (Looks Good To Me)
Seção intitulada “2. LGTM (Looks Good To Me)”Abreviacao que indica que voce revisou e concorda com o merge.
LGTM!Ou mais formal:
LGTM. Great implementation.3. Blocker (problema bloqueante)
Seção intitulada “3. Blocker (problema bloqueante)”Problema serio que deve ser corrigido antes do merge.
Blocker: This will cause a race condition in `handleUserLogin`.Here's why: ...Quando usar:
- Problemas de seguranca
- Regressao de desempenho
- Defeitos funcionais
- Risco de perda de dados
4. Nice catch (boa observacao)
Seção intitulada “4. Nice catch (boa observacao)”Quando alguem encontra um bug, problema de desempenho ou requisito oculto e voce confirma que estao certos.
Nice catch! I didn't think about the edge case where `null` ...Ou:
Good eye! This would definitely break on large datasets.5. Could you elaborate (voce poderia detalhar)
Seção intitulada “5. Could you elaborate (voce poderia detalhar)”Quando voce nao entende por que foi escrito assim ou quer entender a decisao de design.
Could you elaborate on why we're using `Map` instead of `Object`?Versao mais amigavel:
I'm curious about the choice to use `Map` here. Could you walk me through the reasoning?6. Nitpick (versao mais enfatica de “problema pequeno”)
Seção intitulada “6. Nitpick (versao mais enfatica de “problema pequeno”)”Mais direto que “nit”, indica que realmente e um detalhe, mas vale melhorar.
Nitpick: Could we add a blank line here for readability?7. Looks good (concordo com esta parte)
Seção intitulada “7. Looks good (concordo com esta parte)”Usado em situacoes de concordancia parcial. Por exemplo, voce concorda com a logica mas quer perguntar sobre outra parte.
This part looks good. One question about line 42: why are we...?8. We should probably (sugestao)
Seção intitulada “8. We should probably (sugestao)”Sugestao suave, nao obrigatoria mas recomendada.
We should probably add error handling here for the case where the API call fails.9. Have you considered (pergunta aberta)
Seção intitulada “9. Have you considered (pergunta aberta)”Propoe alternativa sem dizer diretamente “deveria ser assim”. Da espaco para o autor pensar.
Have you considered using `useCallback` to prevent unnecessary re-renders?10. Ship it (pode publicar)
Seção intitulada “10. Ship it (pode publicar)”A aprovacao mais casual, significando que voce revisou, nao ha problemas, pode ir para producao.
Ship it!Formula de Educacao para Code Review
Seção intitulada “Formula de Educacao para Code Review”Ao apontar problemas
Seção intitulada “Ao apontar problemas”Formula: Context → Issue → Suggestion
"This code is inefficient"
"In `processUserData`, iterating `O(n^2)` might be slow with large datasets. Could we use a `Set` to get `O(n)` instead?"Ao discordar
Seção intitulada “Ao discordar”Discorda de uma decisao de design?
"That's wrong"
"I see your approach. One concern: `Math.random()` isn't cryptographically secure for auth tokens. Should we use `crypto.getRandomValues()`?"Concordar e fazer perguntas
Seção intitulada “Concordar e fazer perguntas”Nao diga apenas “ok”. Faca perguntas construtivas:
LGTM
LGTM! Curious: did you benchmark this against the regex approach we discussed? I'm wondering if it's noticeably faster for production scale.Modo Express em Code Review
Seção intitulada “Modo Express em Code Review”Sua ideia em portugues → Tres opcoes em ingles → Escolha a mais adequada
Cenario 1: Apontar um bug
Seção intitulada “Cenario 1: Apontar um bug”Voce quer dizer: “Tem uma race condition aqui, multiplas requisicoes vao conflitar”
Abra o Modo Express do DevGlish:
Input: "Tem uma race condition aqui, multiplas requisicoes vao conflitar"
Basic (Direct): "There is a race condition here, multiple requests will conflict"
Intermediate (Natural): "Multiple concurrent requests could cause a race condition"
Native (Idiomatic): "Concurrent requests might race here. Consider using a lock or queue." Dica: De a direcao da solucao em vez de apenas apontar o problemaCenario 2: Sugerir renomear educadamente
Seção intitulada “Cenario 2: Sugerir renomear educadamente”Voce quer dizer: “Esse nome de variavel e muito longo, da pra encurtar”
Input: "Esse nome de variavel e muito longo, da pra encurtar"
Basic (Direct): "This variable name is too long"
Intermediate (Natural): "Could we use a shorter variable name?"
Native (Idiomatic): "Nit: `getCurrentUserAuthenticationStatusFlag` is a bit verbose. How about `isAuthenticated`?" Dica: Fornecer sugestao especifica e mais util do que apenas dizer "encurte"Erros Comuns em Code Review
Seção intitulada “Erros Comuns em Code Review”Interferencia comum de falantes de portugues
Seção intitulada “Interferencia comum de falantes de portugues”| Expressao errada | Razao | Versao melhor |
|---|---|---|
| ”This code is not good” | Muito direto, parece arrogante | ”Could we refactor this for clarity?" |
| "You must change this” | Soa como uma ordem | ”We should probably change this" |
| "This is wrong” | Ofensivo | ”This might cause X in scenario Y" |
| "Please to fix this” | Gramatica incorreta | ”Could you fix this?" |
| "The code of the function is bad” | Uso excessivo de “of" | "The function could be clearer” |
Tabela de Referencia Rapida
Seção intitulada “Tabela de Referencia Rapida”| Situacao | Expressao |
|---|---|
| Concordo + problema pequeno | LGTM, just one nit: … |
| Discordo de uma decisao | I see your approach, but have we considered…? |
| Problema serio | Blocker: This will cause… |
| Sugestao pequena | Nit: Could we…? |
| Concordo + quero aprender | Nice! Could you explain why you chose…? |
| Nao tenho certeza | I’m not sure about this. Could we discuss? |
| Concordo totalmente | LGTM! Ship it. |