Ускорение pull requests в вашей компании с помощью GitHub Copilot

Руководство вдохновлено GitHub в сборнике схем успешного выполнения инженерных систем (ESSP), который рекомендует стратегии и метрики для улучшения инженерных систем.

Если вы начинаете развертывание Copilot, мы рекомендуем определить свои цели, планировать развертывание соответствующим образом и четко взаимодействовать с целями сотрудниками. См . раздел AUTOTITLE.

1. Определение препятствий для успеха

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

Команды часто испытывают задержки при слиянии запросов на вытягивание из-за длительных циклов проверки. Эти задержки часто возникают из следующих:

Сложные изменения кода, которые трудно понять
Несогласованный формат кода, который делает проверки сложными
Общее отсутствие контекста, предоставленного изменениями
Социальные факторы, которые способствуют медленным или сложным проверкам

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

Это приводит к узким местам в процессе разработки и замедляет общую доставку и качество функций.

2. Оценка параметров

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

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

          <a href="https://github.com/enterprise/contact?ref_product=copilot&ref_type=engagement&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline">
          <span>Контактный отдел продаж</span><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-link-external" aria-label="link external icon" role="img"><path d="M3.75 2h3.5a.75.75 0 0 1 0 1.5h-3.5a.25.25 0 0 0-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 0 0 .25-.25v-3.5a.75.75 0 0 1 1.5 0v3.5A1.75 1.75 0 0 1 12.25 14h-8.5A1.75 1.75 0 0 1 2 12.25v-8.5C2 2.784 2.784 2 3.75 2Zm6.854-1h4.146a.25.25 0 0 1 .25.25v4.146a.25.25 0 0 1-.427.177L13.03 4.03 9.28 7.78a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042l3.75-3.75-1.543-1.543A.25.25 0 0 1 10.604 1Z"></path></svg></a>

Как Copilot может помочь

          GitHub Copilot предлагает набор функций, направленных на ускорение процесса проверки pull request, повышение качества кода и улучшение сотрудничества, что в конечном итоге приводит к ускорению времени слияния.

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

Создает полные и полезные сводки pr

          Copilot может автоматически генерировать чёткие и лаконичные PR-резюме, экономя время разработчиков и обеспечивая лёгкое понимание цели и изменений в PR рецензентами. Это снижает вероятность недоразумений и ускоряет процесс проверки.

Помогает рецензентам во время их проверки

          GitHub Copilot может служить мощным спутником для PR-обзоров.

Copilot может помочь объяснить сложные изменения в коде, чтобы рецензенты быстрее понимали, что вносит PR.
Copilot может предоставлять контекстно-ориентированные предложения и возможные улучшения кода на уровне репозитория непосредственно в интерфейсе GitHubобзора pull request, помогая рецензентам выявлять потенциальные проблемы и эффективнее предоставлять конструктивную обратную связь.
Copilot может помочь рецензентам составлять и писать чёткие, последовательные и эффективные комментарии.

Проверки на основе рекомендаций организации

Copilot можете просматривать изменения кода в вашем IDE перед открытием pull request, или быть назначенным рецензентом для pull-запроса.
С наборами правил можно настроить Copilot систематический просмотр pull requests на основе пользовательских критериев.
С помощью индивидуальных инструкций для проверок можно Copilot обеспечивать соблюдение стандартов и лучших практик организации, автоматически отмечая возможные нарушения и предлагая исправления.

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

Предлагает исправления кода

Основываясь на комментарии по отзыву pull request, Copilot это может помочь авторам быстро внедрить необходимые изменения в код для разрешения проверки.

Вопросы культуры

Параллельно с внедрением GitHub Copilot учитывайте любые социальные или культурные факторы, которые могут помешать вам достичь целей.

Ниже приведены примеры из раздела "Антишаблоны" в ESSP.

Teams может ждать слишком долгого выпуска, развертывая большие пакеты кода одновременно. Это может быть вызвано страхом дестабилизации с частыми выпусками, отсутствием зрелости конвейера CI/CD или строгими требованиями к соответствию.
Разработчики могут тратить слишком долгое время на усовершенствование кода или добавление ненужных функций. Это может быть вызвано культурой перфекционизма или отсутствием эффективной приоритетности.
Разработчики могут создавать слишком сложные решения для простых проблем. Это может быть вызвано желанием будущего доказательства ненужным образом или давлением, чтобы добавить ценность через сложность.

3. Реализация изменений

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

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

Создание полезных сводок запроса на вытягивание
Используйте Copilot в качестве помощника по рецензированию
Добавить Copilot как рецензент
Получение справки по реализации комментариев проверки
Рекомендации для разработчиков
Ресурсы

Создание полезных сводок запроса на вытягивание

При создании pull request нажмите на Copilot значок в поле «Добавить описание», затем нажмите Summary.

       Copilot Просмотрю pull request и предоставим обзор изменений, внесённых в Prose, а также маркированный список изменений с файлами, на которые они влияют.

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

Используйте Copilot в качестве помощника по рецензированию

Когда вы переходите в pull request в качестве рецензента, вы можете ускорить Copilot свой обзор.

Используйте Copilot для понимания изменений в pull request.
- Попросите Copilot кратко изложить изменения, внесённые в файл, что особенно полезно для более длинных дифференциальностей. Вы можете выбрать конкретный файл из дифференции, кликнув в правом верхнем углу файла.
- Для изменений в конкретных строках выделите те строки, которые хотите лучше понять, и попросите Copilot объяснить изменения. Вы можете выделить набор строк, щелкнув самый верхний номер строки, удерживая клавишу SHIFT, а затем щелкнув самую нижнюю линию диффа.
```
       **Сотрудничайте над своим PR-обзором** с Copilot. Не забудьте добавить конкретные различия в файлах в разговор перед запросом Copilot.
```
- Вы можете узнать Copilot его мнение о изменениях в PR, спросив: Provide your judgement as a PR Reviewer, both for functional and non-functional aspects that these changes bring. Обратите внимание, что этот запрос просит Copilot учитывать как функциональные, так и нефункциональные аспекты кода.
- Для собственных комментариев к PR-обзору попросите Copilot второе мнение: As my peer reviewer on this pull request, give me your feedback on my own review: YOUR-REVIEW-COMMENT. Do you think it's pertinent? Am I missing something?
Сотрудничайте Copilot над написанием и доработкой комментариев к отзывам.
- После планирования обзора Copilotс помощью , вы можете попросить перечислить комментарии, которые стоит оставить: Make a list of review comments to add to the PR and tell me exactly in which file diff and lines each comment should be added.
- Вы также можете попросить Copilot создать первый черновик обзорного комментария, который у вас есть на уме, или уточнить его перед публикацией: Help me draft review comments as discussed или Refine this review comment to make it clear, concise, and actionable.

Добавить Copilot как рецензент

Чтобы сократить время проверки и быстрее объединить pull-запросы, используйте Copilot обзоры кода систематически: сначала в IDE перед открытием pull request, затем в PR в GitHub.

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

Разработчикам следует запросить проверку всех изменений с помощью Copilot проверки кода перед открытием pull request.
Администраторам следует настроить репозиторий или наборы правил организации, чтобы автоматически добавлять Copilot их как рецензент к любым pull-request, направленным на защищённые ветки.
Тимлиды должны фиксировать стандартный стиль и правила своей команды и устанавливать их как индивидуальные инструкции для организации, Copilot чтобы использовать их в обзорах.
- Убедитесь, что пользовательские инструкции захватывают минимальный набор рекомендаций по стилю, которые упрощают чтение кода, что поможет во время процесса проверка запроса на вытягивание.
- Чтобы уменьшить количество комментариев для PR-обзоров из-за проблем со стилем, установите те же рекомендации в Copilot инструкциях на уровне репозитория и организации. Таким образом, код, сгенерированный им Copilot , будет соответствовать этим требованиям.

Получение справки по реализации комментариев проверки

Авторы pull request могут ускорить решение комментариев по PR-обзорам, быстро внедряя исправления с Copilotпомощью '.

Для любых комментариев, оставленных самим Copilot, либо напрямую коммитировать предлагаемое исправление, либо отредактировать его в Copilot Workspace перед коммингом.
Для комментариев отзывов, оставленных коллегами, перейдите к файловому дифференциалу, связанному с комментарием к PR-обзору, и прикрепляйте его к Копилот Чат беседе. Затем скопируйте комментарий проверки с запросом следующим образом: Suggest a fix for this review comment:
Если вы используете VS Code, попросите GitHub Copilot в режиме агента реализовать необходимые изменения из комментария к отзыву.

Ресурсы

Метрики для просмотра

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

Вот несколько метрик для оценки влияния Copilot на данную конкретную цель.

Удовлетворенность разработчиков: используйте опросы разработчиков для оценки удовлетворенности инженерными инструментами.
Запросы на вытягивание, объединенные для каждого разработчика: вы можете использовать pull request веб-перехватчик, обеспечивая action наличие closed свойства merged внутри pull request объекта true.
Время выполнения запросов на вытягивание: измеряйте среднюю продолжительность времени между созданием и слиянием.
Скорость обхода дефекта запроса на вытягивание: измеряйте частоту проблем развертывания, вызванных плохо проверенными PR.
Тип комментария проверки запроса на вытягивание: скачайте комментарии о проверке pr, классифицируйте их с помощью классификации разделов на основе ИИ и отслеживайте комментарии, сделанные рецензентами по проектированию, масштабируемости и стратегии.