Як відкрити пулл-реквест в github і не облажався

Лінукс там, фронтенд, утиліти всякі.

Розповім, як швидко і просто відкрити пулл-реквест, на що звернути увагу, і зробити так, щоб ваш ревьюер не засмучувався. В кінці статті є чекліст, щоб швидко перевіряти по ньому.

Знайдіть кнопку «Pull Request»

Чи не метушіться і не бігайте по репозиторіїв, перемикаючи гілки. Відразу, як ви запущено, на головній сторінці вашого сховища з'явиться жовта плашка з назвою гілки і кнопкою «Compare pull request ».

Як відкрити пулл-реквест в github і не облажався
Кнопка «Compare pull request »

Ця кнопка - найкоротший шлях до відкриття пулл-реквеста. Тисніть її.

Після натискання кнопки у вас відкриється докладна сторінка про те, звідки і куди ви відкриваєте пулл-реквест. Подивіться, куди увіллється ваш код. Він повинен потрапляти в головну гілку основного сховища. Швидше за все це гілка master. І він повинен бути з вашого ФОРКОМ і гілки, в якій ви робили роботу.

Як відкрити пулл-реквест в github і не облажався
Куди і звідки потрапить код

Швидше за все так і є, якщо ви правильну кнопку натиснули.

Прямо під гілками написано, є конфлікти чи ні:

Як відкрити пулл-реквест в github і не облажався
Ось тут немає конфліктів

Буває, що конфлікти є:

Як відкрити пулл-реквест в github і не облажався

Хорошим тоном вважається відкривати пулл-реквести без конфліктів. Тому якщо у вас конфлікт, вирішите його до того, як відкриєте пулл-реквест. Можна отребейзіть вашу гілку від майстра головного дистрибутива або можна влити майстер головного сховища в вашу гілку.

Якщо ви працюєте в команді і не вмієте вирішувати конфлікти, попросіть старшого товариша вам допомогти. А якщо ви студент, попросіть наставника :) Ви так само можете спочатку відкрити пулл-реквест, нехай і з конфліктами, а потім ці конфлікти вирішити.

Напишіть заголовок і опис

У формі відкриття пулл-реквеста напишіть заголовок: коротко що ви зробили. І опис: що конкретно і навіщо, а що ще не дороблено.

Як відкрити пулл-реквест в github і не облажався

Перевірте змінені файли

Нижче форми з описом пулл-реквеста є дифф - це те, що змінилося: нові файли, видалені файли, змінені рядки в файлах.

Як відкрити пулл-реквест в github і не облажався
Змінені файли (дифф)

На скріншоті вище файл npm-debug.log.1955635711 очевидно зайвий. Значить потрібно його видалити і закоммітіть це, і знову запущено в цю гілку. Якщо ви знайшли помилку, то просто виправте її, закоммітьте і запушьте. Потім поновіть сторінку з Діффа і переконайтеся, що все в порядку.

Тепер тисніть «Create pull request»! Ура!

Як відкрити пулл-реквест:

  1. Після пуша зайдіть в свій репозиторій і натисніть кнопку «Compare pull request »на жовтої плашки.
  2. Перевірте, що відкриваєте пулл-реквест зі своєї гілки в майстер головного сховища.
  3. Перевірте, чи немає конфліктів. Якщо є, виправте їх.
  4. Напишіть заголовок і опис.
  5. Перевірте, що в диффе немає нічого зайвого. Якщо щось зайве попало, приберіть це.
  6. Відкрийте пулл-реквест :)

Підписуйтесь на телеграм-канал про фронтенд, дизайн, роботу і життя.