Код-ревью: зачем оно владельцу сайта или приложения

3 минуты чтения

У вас сайт, интернет-магазин или небольшое приложение. Код для него кто-то написал: подрядчик, знакомый, агентство, с которым вы давно не работаете, или вы сами после нескольких выходных с уроками. Он работает, в основном. Но вы не можете понять, надёжен ли он или держится на скотче. Код-ревью — это взгляд со стороны человека, который код не писал, и оно отвечает на этот вопрос до того, как мелкая проблема станет дорогой.

Код-ревью для сайта или приложения

Когда ревью того стоит

  • Перед оплатой готовой работы. Ревью показывает, разумно ли написан полученный код или он полон костылей.
  • Когда вы принимаете проект. Доставшийся по наследству код без документации — чёрный ящик, пока кто-то его не объяснит.
  • Когда что-то постоянно ломается. Форма, которая иногда не отправляется, медленная страница, ошибка, которая возвращается после каждого исправления.
  • Перед запуском или большой распродажей, когда ошибка стоит реальных денег.
  • Когда вы пишете код сами и хотите понять, что делать лучше.

Что находит ревью

Проверяющий читает код строка за строкой и ищет:

  • Ошибки: логику, которая ломается в отдельных случаях, например при пустой корзине, дате в конце месяца или имени с апострофом.
  • Опасные места: пароли прямо в коде, данные пользователей без проверки, сообщения об ошибках, которые раскрывают слишком много.
  • Слабые места: код, который работает сейчас, но сломается, когда вырастет трафик или обновится библиотека.
  • Читаемость: непонятные названия, длинные функции и повторяющийся код, из-за которых каждое следующее изменение дольше и дороже.

Проблемы сортируются по важности, поэтому вы знаете, что исправлять в первую очередь, а что может подождать.

Чего ревью не делает

Ревью читает и объясняет код; оно не запускает его на вашем сервере и не тестирует работающий сайт. Это не полный аудит безопасности и не нагрузочное тестирование. Считайте предложенные исправления предложениями: тот, кто поддерживает проект, должен проверить каждое, прежде чем оно попадёт на сайт.

Как выбрать, что отправить

Весь сайт нужен редко. Выберите самые важные части:

  • Где движутся деньги: оформление заказа, оплата, цены и скидки.
  • Где пользователи что-то вводят: регистрация, вход, формы обратной связи и поиска.
  • Где проблема: файл или функция, из-за которых появляется ошибка.

Несколько сотен строк из нужного места скажут больше, чем тысячи строк всего подряд.

Как подготовить код

  • Уберите секреты. Замените пароли, API-ключи и данные клиентов заглушками вроде PASSWORD_HERE.
  • Укажите язык и версию, например PHP 8 или JavaScript с React.
  • Опишите, что должен делать код, в одном-двух простых предложениях.
  • Скопируйте точный текст ошибки, если она есть, целиком.
  • Скажите, на чём сосредоточиться: на ошибке, скорости, читаемости или опасных местах.

Как использовать результат

Передайте ревью тому, кто поддерживает код, и договоритесь о порядке исправлений, начиная с критичных. Если вы сами не технический специалист, краткое изложение простыми словами поможет задать правильные вопросы и оценить ответы.

Коротко

Код-ревью — независимый взгляд, который находит ошибки, опасные и слабые места раньше ваших клиентов. Если хотите проверить свой код, закажите код-ревью: вы вставляете до 100, 400 или 1 000 строк и описываете, что идёт не так, а получаете письменное объяснение того, что делает код, список проблем по важности и исправленные фрагменты, которые нужно проверить в вашем проекте. Оплата переходит сервису только после того, как вы примете работу.