Github как изменить название pull request

5 ответов

Лучший ответ

curl --user "your_github_username" 
     --request PATCH 
     --data '{"title":"newtitle","body":"newbody",...}' 
     https://api.github.com/repos/:owner/:repo/pulls/:number

curl --user "jeremyclement" 
     --request PATCH 
     --data '{"title":"allows the control of files and folders permissions."}' 
     https://api.github.com/repos/Gregwar/Cache/pulls/9

Перевод статьи «How to make your first pull request on GitHub».

Что такое форк?

Когда нам нравится чей-то репозиторий и мы хотели бы иметь его в собственном аккаунте на GitHub, мы делаем форк («вилку») этого репозитория, чтобы иметь возможность работать с ним отдельно.

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

Что такое пул-реквест?

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

Например, пользователь Павел делает
форк репозитория ThanoshanMV (автора статьи,
— прим. перев.) и вносит изменения в свой
экземпляр. После этого Павел отсылает
пул-реквест ThanoshanMV, который может либо
принять его, либо отклонить. По сути это
что-то вроде письма «Не будете ли вы так
любезны, уважаемый ThanoshanMV, внести мои
изменения в свой оригинальный репозиторий?»

Как можно стать контрибьютором
проекта?

Участие в проекте с открытым исходным
кодом не обязательно предполагает
работу именно с кодом. Контрибьютором
(участником) можно стать и другими
способами, некоторые из них описаны
ниже.

1. Дизайн. Можно создать макеты
   проекта, чтобы повысить удобство его
   использования, усовершенствовать
   навигацию или меню, создать рисунки
   для лого или футболок, написать
   руководство по стилю проекта.
2. Писательство. Можно написать
   документацию проекта или улучшить уже
   существующую, перевести документацию
   на свой язык, создать новостную рассылку
   для проекта, написать руководства для
   пользователей или заняться формированием
   папки с примерами использования.
3. Организаторские задачи. Можно
   связывать дублирующиеся issues, предлагать
   новые метки для issues, предлагать закрытие
   старых, но еще открытых issues, задавать
   вопросы в новых — чтобы подстегивать
   развитие дискуссии.
4. Помощь другим людям. Можно
   отвечать на вопросы в открытых issues,
   проверять код других разработчиков,
   предлагать помощь в качестве наставника.
5. Написание кода. Можно помогать
   в решении возникших проблем, предлагать
   создание новых фич, а также улучшать
   инструментарий и тестирование.

Давайте создадим наш первый
пул-реквест!

1. Форк репозитория

Чтобы сделать форк репозитория, нужно
нажать кнопку «Fork» в верху страницы.
Таким образом вы создадите экземпляр
всего этого репозитория в своем аккаунте.

2. Клонирование репозитория

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

Чтобы клонировать репозиторий, нажмите
кнопку «clone» и скопируйте ссылку.

Откройте терминал и запустите следующую
команду. С ее помощью репозиторий будет
клонирован на вашу машину.

$ git clone [HTTPS ADDRESS]

Теперь у вас есть копия ветки master
основного онлайн-репозитория проекта.

Переходим в клонированную директорию:

$ cd [NAME OF REPOSITORY]

3. Создание ветки

При работе с репозиторием хорошей
практикой считается создание отдельной
ветки для внесения изменений, причем
это не зависит от размеров проекта.

Имя ветки должно быть коротким и
отражать те изменения, которые вы
вносите.

Создадим ветку при помощи команды git
checkout:

$ git checkout -b [Branch Name]

4. Внесение изменений и коммит

Внесите необходимы изменения в проект
и сохраните их. Затем запустите команду
git status: вы увидите внесенные изменения.

Добавьте эти изменения в только что
созданную ветку при помощи команды git
add:

$ git add .

Теперь вы можете сделать коммит этих
изменений при помощи команды git commit:

$ git commit -m "Adding an article to week 02 of articles of the week"

5. Отправка изменений на
GitHub

Чтобы отправить изменения на GitHub
(сделать push), нужно определить имя
удаленного репозитория.

$ git remote

Имя данного удаленного репозитория
— «origin».

После определения имени можно безопасно
отправить изменения на GitHub.

git push origin [Branch Name]

6. Создание пул-реквеста

Перейдите в свой репозиторий на GitHub.
Там есть кнопка «Compare & pull request» —
кликните ее.

Введите необходимые детали относительно того, что именно вы сделали (чтобы поставить ссылку на issues, возмользуйтесь знаком «решетки»). После этого можно нажать кнопку подтверждения внизу.

Поздравляю! Вы создали свой первый пул-реквест. Если его примут, вы получите уведомление по электронной почте.

7. Синхронизация вашего форка
с основной веткой

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

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

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

1. Для начала, проверьте, в какой ветке
вы находитесь.

$ git branch

Вы получите список всех веток, причем
активная будет подсвечена зеленым.

2. Переключитесь в ветку master.

$ git checkout master

3. Добавьте оригинальный репозиторий
в качестве upstream-репозитория.

Чтобы вытащить изменения из оригинального репозитория и перенести их в свою версию, нужно добавить оригинальный git-репозиторий в качестве upstream-репозитория.

$ git remote add upstream [HTTPS]

Здесь [HTTPS] это url, который нужно
скопировать из основного репозитория.

4. Fetch репозитория

Заберите (fetch) все изменения из
оригинального репозитория. Коммиты,
сделанные в оригинальном репозитории,
будут сохранены в локальной ветке под
названием upstream/master.

$ git fetch upstream

5. Слейте изменения

Слейте (merge) изменения из upstream/master с
вашей локальной веткой master. Таким образом
главная ветка вашего форка репозитория
синхронизируется с upstream-репозиторием
без потери ваших локальных изменений.

$ git merge upstream/master

6. Отправьте изменения на GitHub

На этом этапе ваша локальная ветка
синхронизирована с веткой master оригинального
репозитория. Если вы хотите обновить
свой GitHub-репозиторий, нужно отправить
в него изменения.

$ git push origin master

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

$ git remote rm [Remote Name]

8. Удаление ненужной ветки

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

$ git branch -d [Branch Name]

Вы можете удалить и версию этой ветки
на GitHub.

git push origin --delete [Branch Name]

Итоги

GitHub это мощный инструмент для контроля
истории версий. Каждый может стать
контрибьютором проекта с открытым
исходным кодом. Делается это путем
отправки пул-реквестов.

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

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

Edit me

На предыдущем занятии Используем клиент GitHub для десктопа, мы использовали Github Desktop для управления рабочим процессом коммитов, ветвления и слияния. На этом занятии мы будем выполнять аналогичные действия, но с использованием браузерного интерфейса, который предоставляет Github, вместо использования терминала или Github Desktop.

Понимание процесса Pull request является важным для анализа изменений в опен-сорс проекте с несколькими участниками. Использование интерфейса GitHub также удобно, если рецензенты не знакомы с терминалом или Github Desktop.

Создание изменение в отдельной ветке

По умолчанию в новом репозитории есть одна ветка с именем «Master». Обычно, когда при внесении изменений или просмотра / редактировании, создается новая ветка и вносятся все изменения в ветку. Затем, по окончании, владелец репо объединяет изменения из новой ветки в «Master» через «pull request».

Для создания изменений в отдельной ветке:

• Со стороны рецензента переходим к тому же репозиторию GitHub, который был создан на предыдущем занятии (можно создать новый репо). Создаем новую ветку, выбрав раскрывающееся меню ветки и введя имя новой ветки, например «sme-review». Затем нажмите клавишу Enter.

При создании новой ветки, содержимое из главной (или любой другой ветки, которая сейчас просматривается) копируется в новую ветку. Процесс похож на «Сохранить как» с существующим документом.

• Кликаем в область ввода текста, а затем кликаем по иконке карандаша («Edit this file»), чтобы отредактировать файл.

• Вносим изменения в контент и прокручиваем вниз экрана до области Commit changes. Поясняем причину изменений и подтверждаем изменения в своей ветке sme-review, нажав кнопку Commit changes.

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

Создание Pull request

Теперь представим, что процесс проверки завершен, и пришло время объединить ветку с мастером. Ветка объединяется с “Master” через Pull request. Любой «соавтор» в команде с правами на запись может инициировать и завершить Pull request (добавлять соавторов можете в «Настройки»> «Соавторы)

Для создания Pull request:

• Находим на экране вкладку “Pull request”.
• Кликаем по кнопке New pull request

• Выбираем ветку (sme-review), которую хотим сравнить с веткой “Master”

Когда мы сравниваем ветку с мастером, мы увидим список всех изменений. Мы можем просмотреть изменения в двух режимах просмотра: Unified или Split (это вкладки, показанные справа от содержимого). Unified показывает правки вместе в одной области содержимого, тогда как split показывает два файла рядом.

• Кликаем на кнопку Create pull request.
• Поясняем pull request и снова кликаем кнопку Create pull request.

Владелец репозитория увидит pull request и сможет принять меры для его объединения.

Процесс Pull request

Теперь посмотрим на процесс со стороны владельцем проекта, который получил новый Pull request. Владельцу нужно обработать Pull request и объединить ветку sme-review с “Master”.

• Переходим на вкладку “Pull requests”, чтобы увидеть ожидающие запросы на извлечение.
• Кликаем по запросу и смотрим изменения, выбрав вкладку Files changed.

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

• Переходим на вкладку “Conversation” и кликаем кнопку Merge pull request.
• кликаем Confirm merge.

Ветка sme-review объединяется с мастером. Теперь “Master” и ветка sme-review совпадают (ветки “смержены”).

• Кликаем кнопку Delete branch для удаления ветки sme-review.

Не обязательно удалять ветку сразу. Старые ветки всегда можете удалить , щелкнув ссылку на ветки при просмотре репозитория Github, а затем нажмите кнопку Delete (корзина) рядом с веткой.

Если посмотреть на список веток, то после удаления ветка sme-review больше не отображается.

Добавление участников в проект

Иногда необходимо добавлять соавторов в проект Github, чтобы они могли вносить изменения в ветку. Если другие участники проекта, не являясь соавторами, захотят внести изменения, они получат сообщение об ошибке. (Inviting collaborators to a personal repository)

Человек без прав на запись, может “форкнуть” (скопировать) репо, а не вносить изменения в ветку в том же проекте. Однако копирование проекта клонирует весь репозиторий, а не создает ветку в том же репозитории. Форк (копия) будет существовать в учетной записи пользователя GitHub. Можно объединить форкнутый репозиторий (это типичная модель для опен-сорс проектов со многими внешними участниками), но этот сценарий, вероятно, менее распространен для технических писателей, работающих с разработчиками в тех же проектах.

Для добавления соавторов в проект:

• В репозитории проекта переходи на вкладку “Settings”.
• Нажимаем на кнопку Collaborators в левой части.
• Вводим имена пользователей Github тех, кому хотим дать доступ в области Collaborator.
• Нажимаем на кнопку Add collaborator.

🔙

Go next ➡