Код-ревью

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

Автоматическое ревью

Автоматическое ревью — это особый механизм в упражнениях и испытаниях на сайте Хекслета. Он позволяет:

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

Даже если код работает, его почти всегда можно улучшить, и тут очень пригодится опыт других людей. Поддержка Хекслета не делает код-ревью студентам, однако его можно попросить у своего наставника, если вы учитесь в индивидуальном формате.

Как сохранить решение на сайте

  1. Запустите автоматические тесты
  2. На вкладке OUTPUT появятся результаты проверки
  3. Нажмите на кнопку «Отправить на ревью». Система сохранит решение, и кнопка изменится на «Посмотреть ревью»

Страница автоматического ревью

На странице есть нескольких вкладок:

  • условие задания
  • решение студента и решение учителя, которое видно после успешного завершения упражнения
  • тесты и их вывод

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

Список всех ваших автоматических ревью находится в личном кабинете — «Обучение» → «Мои ревью». Также ссылки на ревью есть в профиле студента во вкладке «Курсы». Чтобы их увидеть, нажмите на стрелочку справа от названия курса.

Код-ревью домашних заданий (Issue на Gitlab)

Домашние задания — это практические задания, которые студент скачивает утилитой hexlet/cli на свой компьютер, выполняет локально и сдаёт наставнику на Gitlab. Они заменяют собой упражнения на сайте, когда обучение идёт в вебинарном формате с наставником. Не путайте домашние задания с самостоятельными заданиями, которые есть в некоторых курсах. Если вы учитесь в группе, куратор расскажет, как сдавать домашние задания.

Каждое домашнее задание проверяет наставник и делает текстовое код-ревью, где рассказывает что и почему стоит исправить или улучшить и какие темы закрепляются с помощью этой задачи.

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

Код-ревью проектов

Для проектов, которые студенты выполняют в индивидуальном или групповом форматах, наставники делают код-ревью в интерфейсе сайта. Они опираются на чёткие критерии проверки и пошагово, итеративно помогают улучшить проект. Если проект не прошёл автоматическую проверку, то в первую очередь наставник поможет разобраться с ошибками, из-за которых падают тесты, и научит их правильно читать и трактовать.

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

Если проект был сделан самостоятельно и принят автоматической проверкой, получить код-ревью от наставника тоже будет полезно. Для этого нужно сменить формат обучения и поработать с наставником индивидуально. Оставьте заявку, мы с вами свяжемся и поможем всё организовать.