Можно ли создать автоматический шаблон для запросов на загрузку в Github?

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

Это может быть либо заметка, либо комментарий. В идеале он отобразит рекомендации по просмотру запроса на растяжение:

- [ ] Have you done x?
- [ ] Have you done y?
- [ ] Have you done z?

Может кто-нибудь предложить способ сделать это?

ОТВЕТЫ

Ответ 1

Да, теперь это возможно.

Добавьте файл с именем pull_request_template.md в корень вашего проекта:

- [ ] Have you done x?
- [ ] Have you done y?
- [ ] Have you done z?

Вы также можете создать шаблон для проблем с использованием того же соглашения. Просто назовите файл issue_template.md.

Источник: https://github.com/blog/2111-issue-and-pull-request-templates

Ответ 2

GitHub не позволяет создавать шаблон для запросов на запросы, созданных на нем.

Мы используем решение для создания запросов на тягу с помощью github api с помощью команды hub. Мы завершаем это в script, называемом makePR, что-то вроде:

#!/bin/bash
URL=$(hub pull-request -F PR-template.md)
echo "New PR created at $URL"
open $URL

(untested - наш фактический script делает намного больше - я ушел из параметров, которые, как мне кажется, вам не нужны)

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

Ответ 4

К сожалению, это невозможно с GitHub. Хорошие новости, GitHub теперь поддерживает это! Проверьте принятый ответ.

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

Из Руководящие принципы для Блог Github:

Мы пробовали сделать это легко для всех. Как сопровождающий, все, что вам нужно сделать, это добавить файл CONTRIBUTING (или CONTRIBUTING.md, если вы используете Markdown) в корень вашего репозитория. Затем мы добавим ссылку на ваш файл, когда вкладчик создаст проблему или откроет запрос Pull.

GitHub screenshot

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

Ответ 5

Существует расширение chrome, которое утверждает, что делает это здесь: https://github.com/sprintly/pull-request-template-chrome-extension

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

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

Ответ 6

В настоящее время можно создавать шаблоны для проблем и тянуть запросы. Он может быть описан в файлах ISSUE_TEMPLATE или PULL_REQUEST_TEMPLATE в корне репозитория или в папке .github.

Здесь вы можете найти дополнительную информацию https://github.com/blog/2111-issue-and-pull-request-templates