How to Request a Pair Review in English

Попросити когось переглянути PR у режимі реального часу, з екрану на екран, це зовсім інше запитання, ніж залишити асинхронні коментарі, і те, як ви сформулюєте запит, визначить, чи буде він виглядати так: « Давайте разом розглянемо щось складне » або « Мені потрібна допомога, бо я застряг ». Цей підручник стосується формування запитів.

Ключовий словник

** Парний перегляд ** — синхронний перегляд коду на спільному екрані, за якого автор і переглядач разом переглядають зміни у реальному часі. Зазвичай, цей режим призначено для складних або високоризичних змін, у яких асинхронні коментарі були б повільними і неефективними. “Враховуючи, наскільки це торкається шляху оплати, я краще зроблю парний огляд, ніж залишу це для асинхронних коментарів - деякі складні частини легше пояснити вживу.”

** Синхронізація проти асинхронного перегляду ** — відмінність між спільним переглядом у реальному часі (синхронізація) і залишенням письмових коментарів для автора, щоб він міг розглянути їх самостійно пізніше (асинхронний перегляд), це вибір, який варто вказати у запиті на перегляд.

• “Цей скрипт, ймовірно, працює асинхронно, але скрипт міграції потребує перегляду синхронізації, враховуючи те, як легко можна щось пропустити у написаній гілці коментарів.” *

** Прочитання** — переказ рецензенту причин зміни у усній формі перед або під час перегляду, особливо корисний для неочевидних рішень щодо дизайну, які потребують багато коментарів для пояснення у письмовій формі.

• “Можу я дати вам п’ ять хвилин на обговорення підходу до цього питання, перш ніж ви займетеся порівняннями? Це врятує вас від повторного виведення обмежень, під якими я працював.”*

** Time- box (парний сеанс) ** — явне обмеження тривалості парного сеансу перегляду, коли запитується, з урахуванням часу переглядача і спрощення відповіді на запитання « так ». “Може, ми б могли провести п’ятнадцять хвилин над цим? Я навмисно встановив час — щасливий продовжити асинхронно, якщо нам потрібно більше.»

Звичайні фрази

• “Чи не маєте ви двадцять хвилин на огляд цього? Це торкається деяких складних паралельних логік»
• «Це легше пройти наживо, ніж у коментарях — чи маєте ви час сьогодні або завтра?»
• «Чи можу я дати вам короткий огляд, перш ніж ви поглянете на відмінності?»
• «Я затримав це на п’ятнадцять хвилин — дайте мені знати, якщо це не працює з вашим розкладом»
• «Щасливий зробити цей асинхронний, якщо зараз не найкращий час, просто флагінг це може бути швидше живий»

Приклади висловлювань

Запит перегляду пари без звуку затримки: “Ця PR переробляє логіку повторних спроб, і я думаю, що прямий огляд буде швидшим, ніж довга гілка коментарів — чи маєте ви 20 хвилин сьогодні післяобідньо?”

Складність, а не особиста потреба:

• “Сама зміна невелика, але її причина не очевидна лише з порівняння — швидкий перегляд пар заощадить вам час у порівнянні з читанням п’ яти абзаців коментарів.” *

Надання резервного асинхронного доступу:

• “Якщо слот синхронізації не працює цього тижня, я напишу обґрунтування в описі PR замість цього — просто подумав, що перегляд пари може бути швидшим, враховуючи крайній термін.” *

Професійні поради

• Формуйте запит на парний перегляд навколо складності зміни, а не вашої власної невизначеності — «це складно пояснити письмово» звучить дуже по-різному від «я не впевнений, що це правильно»
• Надати можливість вибору між ** синхронізацією і асинхронізацією ** явно, а не припустити — це враховує розклад переглядача і сигналізує, що ви не вимагаєте від нього негайного виконання роботи.
• Використовувати ** talk- through ** для завантаження контексту перед тим, як рецензент почне читати — це набагато ефективніше, ніж дозволяти йому виявляти обмеження коментар за коментарем.
• Time-box запит, коли ви питаєте — відкритий “можемо ми перейти на дзвінок” є важче так, ніж “може я можу 15 хвилин.”

Практичні вправи

1. Написати повідомлення з запитом на перегляд пар для певного типу складної зміни.
2. Напишіть речення, у якому буде запропоновано рецензенту як синхронізований, так і асинхронний варіант.
3. Напишіть короткий опис рішення щодо розробки, який ви бажаєте пояснити перед тим, як рецензент прочитає файл diff.

Наприклад, описати значення параметрів: Надати опис параметрів

Запит на перегляд пар є важливим навиком для будь- якого розробника, незалежно від рідної мови. Це співпраця, обмін знаннями, і, врешті-решт, виробництво кращого коду. Однак, як ви сформулюєте свій запит може значно вплинути на те, як він буде прийнятий - не тільки з точки зору того, чи погодиться хтось допомогти, але і в формуванні їх підходу до перегляду. Багато розробників, особливо ті, що все ще розвивають свій професійний англійський словник, борються з вираженням цієї потреби чітко і впевнено. Просте «Чи можете ви подивитися на мій код?» може відчувати себе вимогливим або навіть свідчити про відсутність самодостатності. Давайте розглянемо деякі більш складні фрази, які демонструють повагу до часу і досвіду вашого колеги, одночасно виражаючи ваше бажання співпрацювати.

Однією з ключових областей, на які варто зосередитись, є оформлення запитів як можливості для взаємного навчання, а не як прохання про допомогу. Замість того, щоб запитати « Чи можете ви переглянути це?», спробуйте сформулювати запитання так: « Я працюю над реалізацією [назва можливості] і дійсно ціную новий погляд, щоб переконатися, що я підходжу до цього питання ефективно — особливо щодо [особливої області, що потребує вашої уваги, наприклад, взаємодії з базою даних] ». Зауважте, що це вводить елемент співпраці (« новий погляд ») і підкреслює вашу готовність шукати поради щодо певного аспекту. Аналогічно, в Slack, замість того, щоб надіслати простий «Перегляньте мою PR?», Розгляньте: «Гей @ [ім’я користувача колеги], я тільки що відправив чернетку PR для [назва функції]. Я особливо зацікавлений у отриманні певного відгуку на наслідки виконання — чи не були б ви відкриті для швидкого погляду, коли у вас є хвилина?» — Використання @ згадки робить це більш розмовним і особистим.

Крім того, активне пропонування власної точки зору може збудувати довіру і продемонструвати, що ви не просто шукаєте « так » або « ні ». Ви можете сказати: « Я розглядав [конкретний вибір дизайну] для цієї секції, але я хотів би дізнатися ваші думки щодо того, чи відповідає це більш широким архітектурним цілям ». Це показує, що ви задумались над проблемою і справді зацікавлені в їхній думку. Пам’ ятайте, що час може бути обмеженим: « Якщо ви занадто зайняті, не хвилюйтеся — просто швидкий погляд буде чудовим! » Це показує, що ви враховуєте навантаження вашого колеги і зменшує будь- яке тиск, щоб негайно прийняти запит. Метою є встановлення взаємного обміну ідеями і зворотним зв’язком.