Кава-брейк #38. Що таке код-рев'ю і навіщо це потрібно? Синдром самозванця - найкращий друг розробника

Що таке код-рев'ю і навіщо це потрібно?

Джерело: DZone Створити стартап складно, але написати для нього програмне забезпечення не легше. Щоб софт добре працював, потрібний непоганий код. Але як переконатися, що ваш код дійсно хороший? Працюючи з клієнтським кодом, ми виявабо, що багато розробників-фрілансерів і навіть IT-компанії ігнорують код-рев'ю (code review). І оскільки наша команда вважає перевірку коду стандартним етапом роботи, ми вирішабо пояснити нашу точку зору. Отже, почнемо з базової термінології.

Що таке код-рев'ю?

Це систематична перевірка вихідного коду програмного забезпечення, призначена для пошуку помилок та оцінки якості. Огляд коду складається з наступних етапів:

• Визначення найефективніших способів виконання завдання;
• пошук логічних помилок;
• Пошук найпоширеніших уразливостей;
• Виявлення шкідливих програм – особливий вид перевірки коду для пошуку підозрілих фрагментів коду або пошуку та будь-яких шкідливих програм, інтегрованих у програмне забезпечення.

Навіщо потрібний код-рев'ю?

Існує кілька причин, через які перевірка коду вважається необхідною частиною розробки. Перша причина – зниження ризиків. Припустимо, у вас є програмне забезпечення, написане фрілансером або агентством, але ви не впевнені як робота, тому що навіть хороші розробники можуть щось упустити. Так що повторна перевірка — завжди хороша ідея. Більше того, працюючи разом над вивченням коду, кожен член команди може запропонувати розумніші рішення, які покращать загальну продуктивність проекту. Головне, що потрібно пам'ятати про перевірку коду, це те, що її слід виконувати ДО того, як ваша нова команда розробників візьметься за кодову базу або проект. Рев'ю коду перед запуском проекту дає вашій команді можливість ознайомитися з ним та визначити якість коду і те, чи потрібні доопрацювання.

Путівник по рев'ю коду

Ми вирішабо підготувати на основі свого досвіду короткий посібник для розробників, які збираються перевіряти вихідний код своїх проектів.

Розділіть код-рев'ю на часові інтервали

Не намагайтеся проаналізувати весь проект одразу. Фахівці радять не переглядати одразу понад 400 рядків коду. Причому разова перевірка має тривати не більше години. Люди не можуть ефективно обробляти такий обсяг інформації, особливо протягом тривалого часу. Коли ви перевищуєте цю позначку, здатність виявляти помилки помітно знижується, тому можна пропустити деякі важливі помилки.

Зверніться за допомогою до товаришів за командою

Одна голова добре а дві краще. Ви можете бути здивовані, наскільки підвищиться якість огляду, якщо ви поділитеся цим процесом із кимось іншим. Ми звикли виконувати спільну перевірку коду за допомогою Crucible від Atlassian. Цей інструмент дозволяє призначати додаткові рецензенти, обговорювати виділені рядки вихідного коду, файли або весь набір змін. Спільна перевірка коду не лише покращує програмне забезпечення, а й підвищує рівень компетентності команди за рахунок обміну знаннями під час обговорення.

Фіксація показників

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

Зберігайте позитивний настрій

Огляд коду може іноді погіршити відносини всередині команди. Ніхто не любить, коли його критикують, тому дуже важливо підтримувати дружню атмосферу, якщо ви не хочете, щоб ваші колеги втратабо мотивацію. Замість того, щоб сприймати кожну помилку негативно, подумайте, що це нові можливості для покращення якості коду в цілому.

Налаштуйте процес виправлення помилок

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

Підбиття підсумків

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

Синдром самозванця - найкращий друг розробника

Джерело: Catalins.tech Прочитавши заголовок, вам може здатися, що зі мною щось не так. Але я повторюся: синдром самозванця — найкращий друг розробника, якщо направити його у потрібне русло. Я також вважаю, що синдром самозванця настільки широко поширений у розробці ПЗ через великий обсяг знань, якими ви повинні володіти, постійної зміни інструментів та мов програмування. Мова програмування та інструменти, які ви використовуєте сьогодні, можуть застаріти вже за рік. Це означає, що вам знову доведеться певною мірою «починати з нуля». Створення програмного забезпечення — дуже динамічне середовище, в якому потрібно постійно вчитися. Але незважаючи на труднощі, до них можна звикнути. Таким чином, позбутися синдрому самозванця практично неможливо. Чому б тоді не навчитися жити з ним?

Більшість із нас він є

Дозвольте мені сказати ще дещо. Майже всі ми страждаємо на синдром самозванця. Завжди є хтось кращий за нас. Завжди є щось, чого ми не знаємо. Завжди є чому повчитися. Щодня виходить новий інструмент. Іноді з'являються нові технології чи мову програмування. Ви ніколи не зможете все це вивчити. Намагатися не відставати також дуже складно. І так з'являється синдром. Ви починаєте ставити собі запитання: «Чи зможу я коли-небудь це зробити?», «Чи зможу я коли-небудь робити x, y, z?», «Чи дізнаюся технології x, y, z? »,«Що, якщо я самозванець?», і цей перелік можна продовжити. Відповідь - так, так і так. До речі, синдром самозванця проходить гірше у тих новачків, які відчувають, що ніколи не досягнуть успіху в цій галузі. Я також через це пройшов. Подолати синдром можна наполегливою працею.

Уявіть собі

Ви не єдиний, хто ставить собі ці питання. У вашого колеги по роботі ті самі проблеми. У розробника, на якого ви підписані у Твіттері, також виникають такі питання. І у відеоблогера із 50000 передплатниками. І переді мною теж постають ці питання, хоча я маю роботу і все добре. Запитання турбують не лише вас. Синдром самозванця – частина нашої професії. Звичайно, деякі люди справляються з цим краще, тому не так очевидно, що вони теж мають проблеми. Але повірте: вони майже у всіх нас.

Що ж робити?

Насамперед, ви повинні розуміти, що синдром самозванця може стати вашим найкращим другом. Адже він підштовхує вас ставати краще. Відчуття, що ви не створені для цієї галузі, або що ви мало знаєте, може стати стимулом для того, щоб дізнатися більше. В результаті з кожним днем ​​ви стаєте кращими. Я використовую синдром самозванця як паливо, як мотивацію стати найкращим розробником, і це працює дуже добре. Але будьте обережні, це може швидко підштовхнути вас до вигоряння. Повірте, це вам не потрібно. Щоразу, коли питання та ірраціональні думки закрадаються у вашу голову, ПАМ'ЯТАЙТЕ, що всі розробники страждають таким же синдромом. ПОМ'ЯТАЙТЕ, що завжди є розробник краще за вас. Але також ПАМ'ЯТАЙТЕ, що завжди є розробник, який гірший за вас. ПАМ'ЯТАЙТЕ, що ви ніколи не можете дізнатися про все, і це нормально. Вам потрібно знати лише кілька інструментів, які стосуються вашої роботи. Доклавши завзятість, ви можете стати гарним розробником. Ви думаєте, що станете найкращим програмістом? Скоріш за все ні. Чи працюватимете ви в Amazon / Facebook / Google / Apple? Ймовірно, також немає. Заробите мільйони? Навряд чи. Але знаєте, що? Це нормально. Вам не потрібно робити нічого з цього, щоб стати гарним розробником. Адже насправді більшість із нас ніколи не досягає всіх цих цілей.

Пам'ятайте

1. Майже в усіх нас синдром самозванця.
2. Ви можете досягти успіху в цій галузі завдяки своїй завзятості.
3. Ви ніколи не дізнаєтесь про все, і це нормально.
4. Завжди є розробники краще за вас, але є і розробники гірші за вас.
5. Вам не обов'язково бути суперзіркою серед програмістів. Достатньо бути добре виконувати свою роботу.