Комментируйте свои пулл-реквесты

Ваш пулл-реквест будет кто-то читать. На интенсиве в HTML Academy его будет читать ваш наставник. На работе — ваши коллеги. В опенсорсе — автор проекта. Если вы напишете, на что в изменениях обратить внимание, и объясните неочевидные моменты, читать пулл-реквест будет проще.

В пулл-реквесте есть вкладка Files changed:

Files Changed
Files Changed

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

Дифф
Дифф (изменения)

Когда вы наводите курсор на строку, в этой строке появляется синяя кнопка с плюсом.

Кнопка добавления комментария
Синяя кнопка добавляет комментарий

Если её нажать, откроется форма комментария:

Форма комментария

Комментируйте ту строку, на которую нужно обратить внимание, или про которую у вас есть вопрос. Напишите к ней комментарий и нажмите зелёную кнопку «Start a review»:

Прокомментируйте и нажмите Start a review

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

Этот комментарий видите только вы

Такой комментарий можно отредактировать или удалить, и никто не узнает, что он был.

Продолжайте комментировать неочевидные места и код, по которому у вас есть вопросы:

Когда вы прокомментировали всё, что хотели, опубликуйте комментарии. Вверху страницы есть зелёная кнопка «Review changes», на которой написано, сколько комментариев вы оставили:

Кнопка Review changes

Жмите, появится окошко, в котором можно написать общий комменатрий. А можно и не писать, главное отправить комментарии кнопкой «Submit review»:

Отправьте все комментарии

Тогда ваши комментарии прилетят в почту наставнику (или коллегам, или автору проекта), и станут видны всем:

Опубликованные комментарии

Вот и всё! Не забывайте комментировать свои пулл-реквесты.

Поделиться
Отправить