Как использовать PR-шаблоны GitHub

Если вы делаете какую-либо работу — независимо от того, с открытым исходным кодом или с закрытым исходным кодом — (хотя я знаю, что большинство из тех, кто использует read this site, связаны с открытым исходным кодом), вы, вероятно, используете какой-то контроль версий, и это, вероятно, GitHub.

Многие из вас либо следят за проектом, либо вносят свой вклад в проект, либо обрабатывают запросы на включение в проект. А как насчет тех проектов, над которыми вы работаете с командой?

Возможно, ваш рабочий процесс выглядит примерно так:

• вы создаете ветку для работы над функцией,
• вы отправляете ветку, чтобы подробно описать работу, которую вы проделали, для экспертной оценки,
• обзор объединен,
• ты продолжаешь.

Но что вы указываете в шаблоне пулреквеста? Каждый раз одно и то же или по-разному? Что делать, если содержание PR связано с чем-то в Trello, Asana, Basecamp или какой-либо другой системе управления проектами?

Вот где в игру вступают шаблоны GitHub PR.

PR-шаблоны на GitHub

Вы можете прочитать все о них на странице, но вот суть (без каламбура):

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

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

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

Например, предположим, что вы работаете над проектом и хотите включить следующую информацию:

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

Я не говорю, что это необходимая информация, но мы использовали ее, и я нашел ее полезной (и приятно видеть, что с течением времени вносятся новые улучшения ).

Но как мы это используем?

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

• ISSUE_TEMPLATE
• PULL_REQUEST_TEMPLATE

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

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

Мило, не так ли?

Это не много, но…

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

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