Есть ли у вас шаблоны, по которым вы оформляете Pull Request?
У меня пригорает от пустых пул реквестов или описаний, которые не помогают ревьюеру
Открываешь такой пул реквест с однострочным описанием, а там 30 файлов изменено.
«Разбирайся сам, дружок», — как бы говорит мне создатель
На фронтенде это особенно больно, потому что разницу до и после можно увидеть только запустив две версии рядом или что-то прокликав.
Чувствуешь заботушку, когда автор это сделал за тебя
У нас завелась завелась практика делать видео демки. Самый простой вариант — позвонить себе в Zoom и записать экран.
Я использую Loom, чтобы не возиться с файлами на компе. Вот пример такой демки: loom.com/share/1b1b76b9…
Первое время было странно записывать видосики, а сейчас без них PR выглядит голым.
Мне они помогают лишний раз убедиться, что финальный вариант работает как надо. Ни что не бесит тестировщиков, как сломанный первый же кейс 😂
Если задача повлекла архитектурные изменения, то я делаю видео ещё и про них.
Альтернативно, коллеги иногда описывают, на какие файлы нужно особо пристально посмотреть.
В наш битбакет не завезли шаблоны PR, но внутренняя договоренность — отвечать на три вопроса:
What — что за изменение
Why — почему оно нужно
How — как сделано
Дальше свободный текст по желанию. Вот пример:
Я получаю удовольствие от описания, которого достаточно для качественного ревью.
Когда меня не заставляют ходить и собирать крупицы знаний о задаче: в жиру за описанием, в скетч за дизайном
Не вижу ничего страшного в том, чтобы отказаться ревьюить пул реквест. Я несколько раз писал «извини, но у меня нет контекста, а этот PR слишком большой»
Понятно, что PR назад не открутишь, но решение находится: ревьюить с автором, найти погруженного человека, слить как есть
Ник Лопин