Английский для code review
Code Review Comments
Как вежливо предлагать правки и принимать критику: модальные смягчители, конструктивные формулировки, лексика ревью.
Смягчаем предложения
В ревью важен тон. Вместо приказа «Rename this» — предложение: We could rename this…, It might be clearer to…, What do you think about…?, Consider extracting…. Модальные could/might/should и «maybe / perhaps» делают комментарий советом, а не требованием. «nit:» (nitpick) помечает мелкое необязательное замечание.
It might be clearer to extract this into a helper. — Возможно, будет понятнее вынести это в хелпер.
What do you think about renaming this variable? — Что думаешь о переименовании этой переменной?
nit: missing a trailing comma here. — мелочь: тут не хватает запятой.
💡 could / might / consider + «what do you think?» = предложение, а не приказ. nit: = необязательная мелочь.
Принимаем критику и лексика ревью
Отвечайте на замечания спокойно: Good point, I'll fix it., Thanks for catching this., Could you clarify what you mean?. Полезная лексика: refactor (переработать), edge case (крайний случай), readability (читаемость), trade-off (компромисс), out of scope (вне рамок задачи).
Good point, I'll fix it. — Хорошее замечание, исправлю.
Thanks for catching this. — Спасибо, что заметил.
That's a valid concern, but it's out of scope for this PR. — Справедливо, но это вне рамок этого PR.
💡 Согласие: Good point / Thanks for catching this. Не понял — Could you clarify? Учите: edge case, readability, trade-off.
Самый тактичный комментарий
Выберите наиболее конструктивный вариант.
- You want a function split up. The best review comment is:
- We could split this into smaller functions — what do you think?
- This function is too long. Rewrite it.
- Why did you write it like this?
- Bad code.
- A reviewer found a real problem. A good response is:
- Good point, I'll fix it.
- It works on my machine.
- You are wrong.
- Whatever.
- Which word means handling an unusual input case?
- edge case
- corner shop
- side effect
- deadline
Смягчители и предлоги
Впишите одно слово.
- It ___ be clearer to rename this method.
- What do you ___ about extracting a helper?
- Thanks for ___ this bug.
- This change is out ___ scope for the PR.
Лексика ревью
Соедините термин с переводом.
- to refactor
- readability
- trade-off
- edge case
- naming
- to address a comment
Фразы ревьюера
Проверяйте перевод по карточкам.
- Consider extracting this into a helper.
- Could you clarify what you mean?
- This looks good to me. (LGTM)
- I'd suggest adding a test for this.
- That's a valid concern.