Опубликовано в Профессии

Как подготовить проект к code review с ментором

Две фигурки осматривают синее соединение в центре маленького моста, одна через лупу, другая указывая пальцем.

Время чтения: 5 мин.

К code review с ментором лучше подготовить ограниченный пакет: что делает проект, какой участок ты хочешь разобрать, как его запустить и какие решения вызывают вопросы. Тогда встреча начнётся с кода и поведения программы. Красивое оформление репозитория полезно, но не заменяет воспроизводимый пример и понятный предмет разговора.

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

Выбери один предмет ревью

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

Собери небольшое изменение в отдельной ветке или удобном diff. Если работа затронула много несвязанных файлов, выдели логический кусок. Ментору должно быть понятно, какие строки относятся к вопросу и что существовало до него.

GitHub рекомендует готовить небольшие сфокусированные pull request. Для учебного review принцип тот же: один ясный предмет облегчает обсуждение причин и последствий. Это не требование уложить любой проект в фиксированное число строк.

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

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

Сделай запуск воспроизводимым

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

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

Проверь доступность всех файлов, на которые ссылается README. Путь к документу на твоём компьютере не откроется у ментора. Ссылки внутри репозитория лучше проверить из той же ветки, которую собираешься показывать.

В руководстве GitHub о README среди основных задач названы назначение проекта и начало работы с ним. Для review добавь к этому один проверочный сценарий, который показывает интересующее поведение.

Подготовь маршрут по коду

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

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

Подготовь объяснение текущего выбора. «Так подсказал AI» или «так делают в уроке» описывает происхождение кода, но не его свойства. Попробуй назвать преимущество, ограничение и способ проверить решение. Если пока не можешь, это хороший отдельный вопрос к разбору.

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

Сохрани демонстрацию поведения

Подготовь два независимых сценария со своими исходными данными. В обычном случае первый пользователь удаляет собственную заметку. Для запрещённого случая создай новую заметку первого пользователя, затем попробуй удалить её от имени второго по известному идентификатору. После отказа прочитай эту заметку от имени владельца: она должна сохраниться. Запрос к действительно отсутствующей записи проверь отдельно. В каждом сценарии покажи ответ сервиса и состояние данных после запроса.

Если известна ошибка, приложи воспроизведение до исправления. Если её уже исправил, покажи тест, который на старой версии падал и на новой проходит. Так можно обсудить, действительно ли проверка обнаруживает нужное нарушение.

Не ограничивайся скриншотом зелёного запуска. По нему обычно непонятно, что проверяется и как подготовлены данные. Команда, вход и ожидаемый результат полезнее как основа разговора. Скриншот пригодится дополнительно, если проблема связана с видимым интерфейсом.

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

Проверь права на материалы

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

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

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

Сформулируй ожидаемую обратную связь

Короткое сообщение можно составить так: «Разбираю удаление заметки в учебном backend-сервисе. Хочу проверить место проверки владельца и тест на чужую запись. Прикладываю ветку, запуск и сценарий на двух пользователях. Особенно интересует, какие риски остаются в текущем решении». Это шаблон по контексту; условия и стек подставь свои.

Уточни, входит ли предварительное чтение в выбранную услугу и какой объём реалистично разобрать. В каталоге hitalent выбирают специалиста, а формат конкретного разбора нужно согласовать. Не рассчитывай, что одна встреча автоматически включает аудит всего приложения.

Подготовь список приоритетов. Если времени хватит на один вопрос, сначала обсудите доступ к чужой записи. Названия файлов и форматирование можно исправить позже. Такая очередь помогает получить пользу даже при ограниченном времени разговора.

Фигурка вставляет синюю перекладину в мост над водой, рядом лежит сломанная перекладина.

Преврати замечания в проверяемые изменения

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

Самостоятельно сделай выбранное изменение и повтори исходные сценарии. На следующем разборе покажи разницу и оставшиеся вопросы. Ценным результатом станет способность объяснить проверку владельца и воспроизвести её защиту на двух аккаунтах.

Найди ментора для разбора проекта

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

Выбрать ментора