Помощь другим пользователям в просмотре изменений

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

Простое внесение изменений в проверку

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

Запись небольших запросов на вытягивание

Цель создать небольшие, ориентированные запросы на вытягивание, которые выполняют одну цель. Более мелкие запросы на вытягивание проще и быстрее просматривать и объединяться, оставляйте меньше места для возникновения ошибок и предоставляйте более четкий журнал изменений.

Предоставление контекста и рекомендаций

Напишите четкие заголовки и описания для запросов на вытягивание, чтобы рецензенты могли быстро понять, что делает запрос на вытягивание. В тексте запроса на вытягивание включите:

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

Чтобы помочь рецензентам, поделитесь нужным типом отзывов. Например, вам нужен быстрый взгляд или более глубокая критика? Кроме того, можно использовать GitHub Copilot для создания сводки запроса на вытягивание. См. статью GitHub Copilot для создания сводок запросов на вытягивание, далее в этой статье.

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

Сначала просмотрите собственный запрос на вытягивание

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

Проверка безопасности

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

• Проверьте дифф зависимостей, чтобы узнать, вводит ли запрос на вытягивание уязвимые зависимости. См . раздел AUTOTITLE.
• Проверьте GitHub Advisory Database, чтобы найти дополнительный контекст и информацию о уязвимых зависимостях.
• Изучите и устраните все неудачные проверки безопасности или рабочие процессы, такие как действие проверки зависимостей или проверка результатов code scanning. См. [раздел AUTOTITLE и Сведения о проверке зависимостей](/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests#about-code-scanning-as-a-pull-request-check).
• Если репозиторий настроил code scanning в качестве проверки запроса на вытягивание, используйте GitHub Copilot Автофикс для предложения исправлений уязвимостей безопасности в коде. См. Рассмотрение оповещений проверки кода в запросах на вытягивание.

Информирование вашей команды

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

Используйте GitHub Copilot для создания сводок запроса на вытягивание

Для создания сводки запроса на вытягивание на GitHubможно использовать Copilot. Сводка поможет рецензентам понять изменения.

1. В GitHubсоздайте запрос на вытягивание или перейдите к существующему запросу на вытягивание.

   Примечание.

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

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

   • Если вы создаете новый запрос на вытягивание, используйте поле "Добавить описание".
   • Если вы добавляете описание в существующий запрос на вытягивание, измените открывающий комментарий.
   • Если вы добавляете сводку в качестве комментария, перейдите в раздел "Добавить комментарий" в нижней части страницы запроса на вытягивание.

3. В заголовке текстового поля выберите , затем нажмите Summary.

   

4. Подождите, пока Copilot создайте сводку, а затем тщательно проверьте результаты.

5. Добавьте дополнительный контекст, который поможет пользователям просматривать запрос на вытягивание.

6. Когда вы удовлетворены описанием, нажмите кнопку "Создать запрос на вытягивание" для нового запроса на вытягивание или обновить комментарий , если вы редактируете существующее описание.

Ссылка на связанные проблемы или проекты

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

• Добавьте ключевые слова, такие как Closes ISSUE-LINK в описании, чтобы автоматически связаться и закрыть проблему при слиянии запроса на вытягивание.
• Используйте Projects для отслеживания работы и ссылки на проект из запроса на вытягивание, что упрощает отслеживание хода выполнения в одном месте. См . раздел AUTOTITLE.

Выделение состояния с помощью меток

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