» » Code review Терминатор. Ревью, за которое вам скажут спасибо

 

Code review Терминатор. Ревью, за которое вам скажут спасибо

Автор: admin от 22-05-2020, 20:01, посмотрело: 420

Code review Терминатор. Ревью, за которое вам скажут спасибо
Рыжик помогает мне ревьюить код. А когда ему что-то не нравится — тоже настоящий Терминатор



«Code review Терминатор», — однажды назвал меня коллега после особо продуктивного ревью. С одной стороны, это тешило ЧСВ и было приятно. С другой — коллега действительно научился чему-то новому, и это позволило писать ему более качественный код. Так что win-win.



После смены работы сменились и коллеги. Но и на новом месте тоже начали благодарить за ревью. Решил разобраться, почему, и разложил по полочкам. Получилось 11 рекомендаций.

Can we please get rid of the brain-damaged stupid networking comment syntax style?" не является вежливой (простите за английский тут, но это прямая речь Линуса Торвальдса и её было бы стрёмно переводить; он там красочно настаивает не использовать определённый вид комментариев, для вида вежливости добавляя «please»).



Code review Терминатор. Ревью, за которое вам скажут спасибо


10. Помогайте



Если в процессе ревью вы проанализировали несколько файлов и в результате нашли альтернативное решение — скиньте коллеге ссылки на эти файлы. Можно даже с номерами строк, так ещё удобнее. Это не займёт много ваших усилий, а вот коллеге может сэкономить порядком времени.



11. Предлагайте, не указывайте



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




  • Оба подхода примерно одинаковы. Если нет объективных причин для выбора нового подхода, то нет причин тратить время и применять его. Disclaimer: единообразие кода — объективная причина.

  • Есть объективная причина, по которой ваш подход лучше. Но почему-то автор кода её не понимает. Пересмотрите вашу аргументацию, объясните ещё раз — а заодно проверьте, не ошибаетесь ли вы сами.

  • Личные конфликты. Это скользкий лёд и действовать тут нужно аккуратно. И это уже выходит за рамки темы ревью.





На этом всё. Суммируя:



Делайте мир вокруг вас чуточку лучше. Делайте хорошие ревью.





UPD. Эта статья — вольный перевод моего же оригинала на английском. Сконвертировал из «перевода» в «статью», чтобы не сбивать с толку читателей.

Источник: Хабр / Интересные публикации

Категория: Информационная безопасность

Уважаемый посетитель, Вы зашли на сайт как незарегистрированный пользователь.
Мы рекомендуем Вам зарегистрироваться либо войти на сайт под своим именем.

Добавление комментария

Имя:*
E-Mail:
Комментарий:
Полужирный Наклонный текст Подчеркнутый текст Зачеркнутый текст | Выравнивание по левому краю По центру Выравнивание по правому краю | Вставка смайликов Выбор цвета | Скрытый текст Вставка цитаты Преобразовать выбранный текст из транслитерации в кириллицу Вставка спойлера
Введите два слова, показанных на изображении: *