Код-рев'ю: як закохати у себе будь-якого рев'юераМайкл Лінч
(Michael Lynch) помітив, що статті про код-рев'ю зазвичай дають поради рев'юерам. Значно рідше можна знайти матеріали про те, як підготувати власний код до рев'ю.
У статті How to Make Your Code Reviewer Fall in Love with You Майкл зібрав рекомендації щодо того, як допомогти рев'юеру переглянути код з найбільшою ефективністю. Так ви зможете самі швидше вчитися (адже навчання - перше завдання код-рев'ю), допоможете вчитися іншим та зведете конфлікти у команді до мінімуму.
Ключова думка, яку слід тримати в голові: ми хочемо зекономити час рев'юера. Залежно від того, як налаштований процес рев'ю на проєкті, рев'юєр може бути не в курсі проблеми, яку ви розв'язуєте, тому надати йому чи їй увесь необхідний контекст – це крок назустріч та допомога обом.
Майкл пропонує 13 кроків для цього. Дещо з цього списку – речі, які ми просто часто забуваємо, інше - тонші психологічні моменти.
Ми винесли запропонований список у цей допис, щоб ви могли вирішити, чи варто читати про них детальніше у статті. Можете перевірити себе за цим списком та додати щось до свого арсеналу.
1. Ретельно прогляньте код самостійно (так, усі іноді забувають)
2. Ясно опишіть, що саме було змінено
3. Автоматизуйте прості задачі
4. Відповідайте на питання за допомогою коду
(це про приклади, а не про спілкування функціями)5. Робіть зміни локалізованими
6. Розділіть функціональні та нефункціональні зміни на окремі пул-реквести
7. Діліть великі за обсягом зміни на кілька пул-реквести
8. Відповідайте на критику чемно
9. Зберігайте терпіння, якщо рев'юер припустився помилки
10. Викладайте свою позицію явно
11. Допомагайте знайти інформацію, якої не вистачає
12. Йдіть на поступки у питаннях, що стосуються смаку
13. Мінімізуйте час між ітераціями рев'ю
