#common

Про ревью.

Что вы думаете, когда видите что-то такое:

> Это какой-то бред.

Оценочное суждение. Никакой конкретики, что же сделано не так. Никаких предложений по исправлению.

> Так лучше не делать.

Как??????????

Писать комменты в ревью адекватно — важный скилл. Как минимум чтобы коллеги не думали, что вы токсичный и неприятный. Как максимум, чтобы исправление ревью было простым и не тратило время вас двоих на выяснение, что же имелось в виду.

Примеры выше имеют несколько важных недостатков: они [вероятно] грубые и не несут никакой конкретики (ваш коллега не имеет никакого контекста о том, что было у вас в голове во время написания комментария).

Как сделать ваше ревью более полезным? Вот несколько набросов:
- цель код ревью в том, чтобы сделать код лучше. Потому при написании комментариев важно фокусироваться именно на коде и написанном, а не на авторе и других аспектах бытия;
- пишите конкретно.
Вот это не будет работать по таким-то причинам: раз, два, три. Можно сделать вот так. Вот ссылка на пример использования/функцию/метод/инструмент.
Донесите вашу мысль максимально чётко, чтобы автор кода понял вас с первого раза;
- не ленитесь и напишите (псевдо)код предлагаемого решения, если оно может показаться нетривиальным.
Вообще максимально старайтесь предлагать какие-то решения (вы же понимаете, как сделать лучше?). Это экономит время;
- по опыту, важно ещё и как вы оставляете комментарий. Если вы предлагаете что-то исправить в формулировке “Можем сделать ….?”, автор имеет полное право сказать “нет”, даже если это решаемый вопрос. Просто потому что не хочет. Напишите лучше что-то вроде “Давай сделаем …”;
- ну и в конце концов, будьте приятными и нетоксичными. Просто по-человечески добрыми. Это всегда приятно. Плюс к фидбеку охотнее прислушиваются, если он написан уважительно.

Будьте добрыми😎