Як зробити відгуки про код веселими (і не страшними)

Я зробив свою неабияку частку оглядів коду. Чесно кажучи, я маю на увазі багато. Ви коли-небудь проводили огляд коду епічної функції? У мене є. Це не було великим досвідом, тому що до того часу, коли повинен був бути переглянутий 100-й файл, я вже втомився, дивлячись на код. Я був так близький до того, щоб просто піти "Так, мені це добре виглядає", а потім дати своє схвалення.

Але не так працюють огляди коду. Після того, як ви розпочали, ви повинні дотримуватися цього і закінчувати до кінця. Звичайно, ви можете робити перерви, але тоді ви починаєте втрачати контекст і доводиться починати все спочатку, наприклад:

Однак я відступаю. Біль - це не те, про що я повинен говорити.

То як же зробити це, скажімо, менш страшним? По-перше, навіть перед тим, як зробити запит на витягування, і навіть до того, як ми почали кодувати, ми повинні вирішити розбити функції на гарні маленькі шматочки. Розробка та розгортання стають швидшими, оскільки завжди легше розгорнути міні-функцію, ніж епічну. Це робить огляди коду простішими та швидшими у виконанні, оскільки зміни досить незначні.

Чудово! Сподіваюся, вам сподобалась моя стаття. Ходімо всі додому ...

Стривай, зупинись !

Це було про те, як зробити це менш жахливим, а як зробити це веселим?

Використання мемів у оглядах коду

Застереження: наступне - це мої власні думки, а не мого роботодавця.

Я просто хотів уникнути цього, оскільки це потенційно може бути суперечливою темою. У будь-якому випадку, ми робимо наші огляди коду легкими, додаючи меми.

Я чую, як звідси котиться твоє око! Вислухай мене. Що може бути кращим поясненням, ніж зв’язати когось іншого, хто з радістю це вже пояснив?

Саме тон допомагає зробити це цікавим як для рецензента, так і для особи, чий код переглядається. Одним з прикладів може бути найперший "основний продукт" у моєму image wallet. Я помітив, що Rubocop бракує подвійних пробілів у наших файлах, тому, коли хтось надсилає запит на вилучення з купою зайвого пробілу, було неважко дати їм дожа.

Це було просте зображення, і все ж повідомлення було дуже ефективним. Пам’ятаю, люди сміялися, коли це бачили. Люди не хотіли “дожувати”, тому всі були пильнішими у своєму додатковому пробілі.

Було простіше відкрити finder, перетягнути дожа до коментаря та опублікувати повідомлення, замість того, щоб просто ввести звичайний старий Please remove the extra whitespaceв запиті на витяг (PR), особливо якщо було кілька дожів.

Хіба це не могло дати зворотного ефекту?

Це цілком могло. Я не кажу, що всі повинні стежити за нашою командою. Це насправді залежить від особистості команди. Наш у середньому вік шість років молодший, а це означає, що більшість може стосуватися мемів. Була б зовсім інша історія, якщо середній вік вашої команди - сорок (якщо, звичайно, вони не були громадянами 4chan або не в курсі останніх мемів!).

Ви насправді найкраще знаєте своїх товаришів по команді. Через кілька місяців перебування один з одним (тим більше, що ми поєднували майже 100% часу), ми якось відчули гумор один одного, так би мовити. Це змусило нас бачити меми в наших PR і просто посміятися над цим (одночасно вирішуючи проблему).

Які переваги ви отримуєте від мемів?

Ну, одна перевага полягає в тому, що це робить перегляд швидшим (принаймні для мене). Людина, яка також подала PR, насправді розуміє, що їм потрібно робити швидше. Замість того, щоб прочитати кілька слів, ви бачите зображення - і всі ми знаємо, що зображення говорять голосніше, ніж слова. Ось кілька прикладів з мого personal image wallet™:

Коли я вивожу зображення вперше, я додаю опис / пояснення щодо того, що їм потрібно зробити / виправити. Вищезазначене в основному говорить про видалення вищезазначеного «застарілого» коду. Видаліть його. Знищи його!

Це характерно для Ruby - pretzel dotоператор - це, в основному, ярлик для a try-catch. Я просто виділяю фрагмент, якому потрібен крендель, і вкладаю це зображення. Швидко і просто!

Ці два я просто використовую як взаємозамінні і знову, В основному в Ruby, де ми завжди додаємо # frozen_string_literal: trueчарівний коментар у верхній частині файлу. Однак із Рубокопом за кермом ми все рідше бачили Ельзу та пана Фріза. Вони також виявляються для будь-якої константи, яка потребує заморожування.

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

Це лише декілька з них. Пам'ятайте, однак, занадто багато чогось зазвичай єне гарна річ. Тож просто подбайте, коли додаєте свої меми. Також краще не додавати занадто багато мемів, оскільки іноді це може відволікати увагу. Знайти правильний баланс тону і просто переслати повідомлення якомога швидше - найкращий спосіб завершити запит на витягування.

Це все, шановні

На закінчення, насправді вирішувати вам, чи хочете ви розважитися, або просто залишатися серйозними та професійними на роботі. Деякі можуть вважати меми непрофесійними - і звичайно, в офіційній роботі вони можуть бути. Можна стверджувати, що запит на витяг може бути або є формальною справою, пов’язаною з роботою, але я думаю, що це стосується лише того випадку, якщо ви використовуєте його для документації чи огляду. В іншому випадку, я вважаю, що це «вільна мова» (так, витягнув цю карту!), І її слід просто сприймати як є.

Для мене він передає те, що я хочу сказати: видалити зайвий пробіл, виправити правопис, заморозити константу або видалити рядок або рядки коду. Мені не доводиться багато друкувати, моєму колезі не доводиться читати купу слів проти іншої групи слів, і це трохи піднімає настрій. Усі перемагають! На цьому я закінчу це ще одним зі своїх зображень: