Запрос на вытягивание предлагает изменения в ветви отдельно от основной базы кода, чтобы другие могли просматривать изменения до их объединения. В этом кратком руководстве описан самый простой путь к запросу на вытягивание. Вы создадите ветвь, внесите и зафиксируете изменения, откройте запрос на вытягивание, ответите на отзывы и слияние.
Вы можете следовать на GitHub веб-сайте или с GitHub CLI помощью одного из вкладок выше.
Ветвь или вилка репозитория
Сначала вы создадите изолированное место для работы.
- В GitHubполе перейдите на главную страницу репозитория, для которого нужно предложить изменения.
- При необходимости, если у вас нет доступа на запись, потребуется вилка. Щелкните "Вилку " в правом верхнем углу и выполните действия. Затем перейдите в вилку репозитория.
- Щелкните меню селектора ветви в верхней части списка файлов. Это, вероятно, говорит главное. Введите новое имя ветви и нажмите кнопку Create branch new-branch-name from main.
-
Чтобы использовать GitHub CLI, сначала необходимо установить его. См . раздел AUTOTITLE.
-
Клонируйте репозиторий. Или вилку репозитория и клонируйте его локально одновременно.
-
Если у вас есть доступ на запись к репозиторию, клонируйте репозиторий:
gh repo clone OWNER/REPO -
Если у вас нет доступа на запись, сначала вы создадите вилку и клонируйте его одновременно.
gh repo fork OWNER/REPO --clone
-
Перейдите в каталог клонированного репозитория.
cd REPO -
Создайте и переключитесь на новую ветвь.
git checkout -b YOUR-BRANCH-NAME
Создание или изменение кода
Внесите изменения в ветвь. Для первого запроса на вытягивание сохраните фокус и простое изменение. Более мелкие запросы на вытягивание быстрее просматриваются и упрощают слияние.
Попробуйте выполнить одно из следующих действий, чтобы внести изменения.
- Изменение файлов локально в интегрированной среде разработки или текстовом редакторе.
- Измените файл непосредственно, GitHub перейдя к нему и щелкнув его.
Часто фиксируйте
Сохраните работу в небольших значимых фиксациях. Каждая фиксация записывает моментальный снимок и сообщение, описывающее изменение.
git add .
git commit -m "Describe your change"
git push --set-upstream origin YOUR-BRANCH-NAME
При изменении файла GitHub и готовности к фиксации вы введете сообщение фиксации и зафиксируете его непосредственно в ветви.
- Нажмите кнопку "Зафиксировать изменения...".
- В поле сообщения "Фиксация " введите краткое описание внесенных изменений.
- Выберите ветвь, с которым вы работаете.
- Нажмите кнопку " Предложить изменения".
Изменение будет добавлено и зафиксировано в ветви.
Открытие запроса на вытягивание
Если в ветви есть изменения, которые вы хотите предложить, откройте запрос на вытягивание в базовой ветви.
- На главной странице репозитория нажмите кнопку "Запросы на вытягивание", а затем нажмите кнопку "Создать запрос на вытягивание".
- Для базовой ветви основной, вероятно, уже выбран и обычно это базовая ветвь, в которую вы будете объединяться.
- Для ветви сравнения выберите ветвь, содержащую изменения.
- Нажмите "Создать pull request".
- Введите заголовок и описание, объясняющее, что вы изменили и почему.
- Вы можете создать запрос на вытягивание, готовый к просмотру или в черновике.
- Если он готов к просмотру, нажмите кнопку "Создать запрос на вытягивание".
- Чтобы предоставить общий доступ к работе, используйте раскрывающийся список и выберите команду "Создать запрос на вытягивание черновика".
Вы можете создать запрос на вытягивание, готовый к просмотру или в черновике.
-
Если он готов к просмотру:
gh pr create -
Предоставление общего доступа к работе
gh pr create --draft
Затем следуйте инструкциям, чтобы задать базовую ветвь, название и описание.
Если вы делаете дальнейшие фиксации в той же ветви, они будут автоматически добавлены в запрос на вытягивание.
Запрос проверки
Чтобы запросить проверку с помощью поля "Рецензенты" , необходимо написать доступ к репозиторию и запросить проверку от человека или команды с доступом на чтение к репозиторию. Если запросить проверку, пользователь или команда получит уведомление. В некоторых случаях вы увидите предлагаемых рецензентов, которые можно выбрать.
Если флажок "Рецензенты " недоступен для вас, можно:
- Проверьте читаемую информацию для репозитория, чтобы получить рекомендации по проверкам запросов на вытягивание и следуйте инструкциям.
- Если вы знаете, кто может сделать обзор для вас, обратитесь к ним и поделитесь ссылкой на запрос на вытягивание.
Отзыв о проверке адреса
Рецензенты могут комментировать, предлагать изменения или запрашивать изменения перед объединением запроса на вытягивание.
- Чтобы принять предложение рецензента, нажмите кнопку "Зафиксировать предложение " (или пакетное несколько и нажмите кнопку "Зафиксировать предложения").
- Чтобы внести более широкие изменения, измените код и отправьте новые фиксации в ту же ветвь. Запрос на вытягивание обновляется автоматически и повторно выполняет все проверки.
- Пометьте каждую беседу как разрешенную после ее устранения.
Слияние и развертывание
После прохождения необходимых проверок и проверок состояния объедините запрос на вытягивание, чтобы перенести изменения в базовую ветвь. Если вы решили не объединить изменения, можно закрыть запрос на вытягивание.
Совет
Различные репозитории могут иметь разные требования для объединения. Просмотрите все соответствующие рекомендации и следуйте инструкциям.
- В нижней части запроса на вытягивание нажмите кнопку "Объединить запрос на вытягивание".
- Нажмите кнопку "Подтвердить" , чтобы завершить слияние.
- (Необязательно) Удалите головную ветвь, чтобы сохранить репозиторий в порядок.
gh pr merge
Следуйте инструкциям, чтобы выбрать метод слияния и при необходимости удалить ветвь.
Дальнейшие действия
После первого запроса на вытягивание попробуйте просмотреть работу другого пользователя. См . раздел AUTOTITLE.