Статьи

Преобразование проблем GitHub в запросы Pull

Июль 24, 2018

Используя   библиотеку Hub , можно конвертировать проблемы Github в запросы pull. Это приводит к полезному рабочему процессу Github, который описывается в этой статье.

В этом нет ничего нового; это было  написано раньше . Тем не менее, это то, чем я занимаюсь все время во время разработки  Оскара,  и мне надоело объяснять это. Эта статья — справочник, на который я могу указать людям.

Процедура:

1) Обсудить

Обсудите идею новой функции в списке рассылки проекта. Согласитесь, что нужно сделать.

2) Укажите

Создайте выпуск Github для этой функции.

Часто полезно написать заявку как краткую функциональную спецификацию, документирующую требования в виде пользовательских историй. Поддержка Github  для флажков в уценке  полезна здесь:

3) Работа

Создайте ветку для работы над этой проблемой:

(master) $ git checkout -b issue/472/django1.5

Я считаю полезным включить номер проблемы в название ветки, но это может не соответствовать вашему вкусу.

Работайте и переходите на свою ветку как обычно.

4) Обзор

Теперь нажмите на пульт:

(issue/472/django1.5) $ git push -u origin issue/472/django1.5

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

(issue/472/django1.5) $ hub pull-request -i 472 -h tangentlabs:issue/472/django1.5

где tangentlabs — это имя пользователя Github владельца удаленного источника.

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

5) Итерация

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

Заметки

Команда pull-request от Hub полезна, но относительно неизвестна. Флаг -i указывает номер проблемы Github, в то время как -h указывает ветвь источника для запроса на получение. Вот соответствующий фрагмент справки:

git pull-request [-f] [TITLE|-i ISSUE|ISSUE-URL] [-b BASE] [-h HEAD]
       Opens a pull request on GitHub for the project that the "origin"
       remote points to. The default head of the pull  request  is  the
       current  branch.  Both  base and head of the pull request can be
       explicitly given in one  of  the  following  formats:  "branch",
       "owner:branch",  "owner/repo:branch".  This  command  will abort
       operation if it detects that the current topic branch has  local
       commits  that  are  not yet pushed to its upstream branch on the
       remote. To skip this check, use -f.

       If TITLE is omitted, a text editor will open in which title  and
       body  of  the  pull request can be entered in the same manner as
       git commit message.

       If instead of normal TITLE an issue number is given with -i, the
       pull  request  will  be  attached  to  an existing GitHub issue.
       Alternatively, instead of title you can paste a full URL  to  an
       issue on GitHub.

Без этой команды вы в конечном итоге создадите отдельный pull-запрос и выполните одну и ту же работу.

Вы можете увидеть этот рабочий процесс в действии через  запросы Оскара .

29
Share: