Код-ревью — это проверка написанного программного кода другим разработчиком или группой разработчиков. Представьте, что вы написали сочинение, а потом отдали его учителю или однокласснику, чтобы он проверил ошибки, дал советы по улучшению и убедился, что всё понятно. В мире программирования это и есть код-ревью.
Этимология
Термин «код-ревью» состоит из двух частей:
- «Код» — программный код, набор инструкций для компьютера
- «Ревью» (от английского «review») — проверка, пересмотр, рецензия
Примеры из жизни
- Школа: Учитель проверяет домашнее задание учеников — это своего рода «ревью»
- Издательство: Редактор проверяет рукопись автора перед публикацией
- Строительство: Прораб осматривает работу, выполненную строителями
- Кулинария: Шеф-повар пробует блюдо, приготовленное су-шефом, и даёт свои замечания
В мире IT
В разработке программного обеспечения код-ревью обычно включает:
- Проверку кода на наличие ошибок
- Оценку качества и эффективности решения
- Анализ соответствия стандартам кодирования
- Предложения по улучшению
- Передачу знаний между участниками команды
Аналогии
- Редактирование текста: Ваш друг проверяет ваше сообщение перед отправкой важного письма
- Проверка контрольной работы: Одноклассники меняются тетрадями и проверяют работы друг друга перед сдачей учителю
- Дегустация еды: Вы даёте попробовать приготовленное блюдо кому-то перед тем, как подать его гостям
Сокращения и акронимы
- CR (Code Review)
- PR (Pull Request) — часто используется в контексте код-ревью в системах контроля версий
- MR (Merge Request) — аналогично PR, используется в некоторых системах, например, GitLab
В процессе код-ревью часто используют сокращения для комментариев:
- LGTM (Looks Good To Me) — код выглядит хорошо
- PTAL (Please Take A Look) — пожалуйста, взгляни на это
- WIP (Work In Progress) — работа ещё не завершена