Skip to content
TheChatArchiveThe Chat Archive
gpt-3.5-turbo-0613· OpenAIAi2 WildChat-4.8M (AI2)

Напиши подробную инструкцию для отдела backend разработки как проводить code review. В…

  1. User

    Напиши подробную инструкцию для отдела backend разработки как проводить code review. В команде 8 backend разработчиков. Ревью одного МР должны провести 2-3 разработчика.

  2. Assistant

    Инструкция для отдела backend разработки: проведение code review

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

    Шаги по проведению code review:

    1. Назначение ревьюеров:

      • Для каждого Merge Request (МР) назначьте 2-3 разработчика из команды backend разработки. Разработчики могут разбить МР на различные модули для ревью или объединиться для полного ревью.
      • Избегайте назначать членов команды на ревью своих собственных МР, чтобы избежать предвзятости.
    2. Подготовка к ревью:

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

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

      • Разработчики могут отвечать на комментарии ревьюеров, задавать уточняющие вопросы и давать объяснения, если это необходимо.
      • Ревьюеры также должны быть готовы объяснить свои замечания и предложения по улучшению кода.
      • Поддерживайте диалог и общение вежливыми и конструктивными.
    5. Проверка исправлений:

      • Разработчик, отправляющий МР, должен обновить его по мере внесения изменений по результатам обсуждений после ревью.
      • После внесения изменений разработчик должен убедиться, что исправления соответствуют комментариям и предложениям ревьюеров.
      • Отправьте уведомление ревьюерам, чтобы они провели окончательное ревью.
    6. Закрытие МР:

      • Если все комментарии решены и улучшения приняты, ревьюер может одобрить МР.
      • Разработчик должен проверить, что тесты проходят успешно и что изменения не вызывают нежелательных побочных эффектов.
      • Разработчик может объединить МР после получения одобрения от всех ревьюеров.
    7. Документирование и обратная связь:

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

    Примечания:

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

    Как сделать так, чтобы ревьюеры проводили ревью в кратчайшие сроки?

  4. Assistant

    Чтобы обеспечить проведение code review в кратчайшие сроки, рекомендуется следовать следующим практикам:

    1. Установите сроки для ревью:

      • Определите разумные сроки для ревью каждого Merge Request (МР), в зависимости от его размера и сложности.
      • Установите четкие сроки завершения ревью и придерживайтесь их.
    2. Уведомляйте ревьюеров вовремя:

      • Сразу после создания МР уведомьте назначенных ревьюеров, чтобы они могли начать ревью как можно скорее.
      • Напомните ревьюерам о назначенных сроках и обратите внимание на важность своевременного проведения ревью.
    3. Подготовьте код для ревью:

      • Проведите необходимые проверки на чистоту кода, конфликты и успешное прохождение тестов перед отправкой МР на ревью.
      • Убедитесь, что код хорошо задокументирован и легко читается.
    4. Укажите на ключевые моменты в МР:

      • При описании МР подчеркните ключевые изменения, основные проблемы, возможные ограничения или принятые решения.
      • Это поможет ревьюерам сосредоточиться на наиболее важных аспектах и сделать ревью более эффективным.
    5. Своевременно отвечайте на комментарии ревьюеров:

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

      • После получения комментариев и предложений по улучшению завершите внесение изменений по мере их обсуждения.
      • Принимайте комментарии конструктивно и обратите внимание на улучшение качества кода.
    7. Используйте автоматизацию:

      • Используйте инструменты для автоматической проверки кода, качества и стиля.
      • Автоматические проверки могут ускорить процесс ревью, освободив ревьюеров от рутинной работы.
    8. Обратная связь и непрерывное совершенствование:

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

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