Есть один очень простой, но удивительно эффективный способ ускорить код-ревью в команде и сделать этот процесс приятнее.
Выложив Pull Request, напишите к нему описание и оставьте комментарии.
Вспомните свои ощущения, когда нужно поделать ревью. Лично я зачастую испытываю лень. Нужно открыть код, разобраться, какую задачу и каким способом он решает, составить собственное мнение, оставить комментарии… Можно устать, просто прочитав это предложение.
Позаботьтесь о своих коллегах. Сделайте короткое описание к PR, расскажите в двух словах о решаемой задаче и способе её решения.
Не нужно растекаться мыслью по древу. Достаточно буквально 3–5 предложений. Читать огромную портянку текста тоже никто не захочет. Описание должно объяснять контекст и риск, а не пересказывать diff.
Сделав это, оставьте комментарии к самому коду:
- на что ревьюерам стоит обратить внимание;
- где вы сомневаетесь в своём решении;
- зачем понадобились доработки общего кода.
Эти комментарии облегчат жизнь человеку, который будет смотреть ваш код. Помогите ему выделить главное и заострить внимание именно на этом.
Вспомните любую хорошую нон-фикшн книгу. У неё всегда есть оглавление, краткое описание и введение. Ключевые мысли выделяются типографическими средствами: шрифтом, цитатами или ещё как-то. Всё это делается для того, чтобы читателю было легко понять назначение и структуру книги, а также выделить главное.
Вы точно так же можете выполнить роль автора для ревьюеров. Сделайте людям приятно и помогите им понять, что же вы там такого написали в своём Pull Request.