Как сделать свой первый Pull Request на GitHub

Как создать PR для редактирования проекта на GitHub?

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

Что делать, если вам просто нужно отредактировать файл, может быть, проект README, чтобы исправить опечатку?

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

Я полагаю, у вас уже есть (бесплатно)GitHubучетная запись. Если вы этого не сделаете, перейдите кgithub.comи получите один.

Позвольте мне показать вам процесс.

Я зашла на эту страницуhttps://web.dev/prefers-color-scheme/и я нашел возможную опечатку. В конце этой строки отсутствует точка.

The article I want to edit

Я не грамматический нацист, это просто для примера 😄

Я знаю, что этот сайт размещен на GitHub, и эта статья размещена здесь:https://github.com/GoogleChrome/web.dev/tree/master/src/site/content/en/blog/prefers-color-scheme

The github folder of the article

Открываю файл index.mdhttps://github.com/GoogleChrome/web.dev/blob/master/src/site/content/en/blog/prefers-color-scheme/index.mdпрямо на GitHub, и я нажимаю значок карандаша на панели инструментов файла. При наведении курсора на него написано «Разветвите этот проект и отредактируйте файл».

The index.md file

Это вызывает окно редактора с этой информацией:

Вы редактируете файл в проекте, к которому у вас нет доступа на запись. Отправка изменения в этот файл приведет к его записи в новую ветку в вашей вилке flaviocopes / web.dev, чтобы вы могли отправить запрос на перенос.

The editor view

Я могу добавить эту точку, а затем в форме внизу я объясню внесенные мной изменения:

Propose file change

Я нажал кнопку «Предложить изменение файла», и появилось окно сравнения.

Compare view

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

Open pull request

В верхней части этого представления вы можете увидеть, что я собираюсь отправить PR вGoogleChrome/web.devпроект из моей формыflaviocopes/web.dev, из моей веткиpatch-2к ихmasterответвляться.

Нажатие кнопки «Create Pull Request» показывает другую форму, в которой я могу написать подробное описание для Pull Request.

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

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

Обратите внимание на подсказку справа? Они говорят мне, что у проекта есть файл CONTRIBUTING.md, в котором объясняется, как внести свой вклад, и приведены рекомендации. Довольно круто.

Contributing

Кажется, нам нужно подписать CLA (лицензионное соглашение участника), чтобы завершить наш PR. Я уже подписывал Google CLA в прошлом, поэтому этот шаг для меня понятен, но вам, возможно, придется это исправить. Большинству проектов это действительно не нужно.

Я нажал «Создать запрос на перенос», и PR отправлен!

Pull Request sent

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

[… Прошло пару часов…]

Я получил электронное письмо обратно, PR был отклонен, потому что точка была на самом деле в правильном месте! (Я этого не знал).

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

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

Также лучше спросить, прежде чем работать над существенным PR, чтобы увидеть, действительно ли это то, что нужно проекту.

Но это отдельная тема.


Дополнительные руководства по git: