Skip to main content

Сведения о шаблонах проблем и запросов на вытягивание

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

После создания шаблонов проблем и запросов на вытягивание в репозитории участники могут использовать их для открытия проблем или описания предлагаемых изменений в запросах на вытягивание в соответствии с рекомендациями по участию в репозитории. Дополнительные сведения о добавлении рекомендаций по участию в репозитории см. в статье Настройка рекомендаций для участников репозитория.

Вы можете создать шаблоны проблем и запросов на вытягивание по умолчанию для своей организации или личной учетной записи. Дополнительные сведения см. в статье "Создание файла работоспособности сообщества по умолчанию".

Шаблоны проблем

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

Страница создания проблемы, на которой показаны варианты шаблонов проблем

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

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

Вы можете настроить средство выбора шаблона проблемы, которое пользователи видят при создании проблемы в репозитории. Для этого добавьте файл config.yml в папку .github/ISSUE_TEMPLATE. Дополнительные сведения см. в статье Настройка шаблонов проблем для репозитория.

Шаблоны проблем хранятся в ветви репозитория по умолчанию в скрытом каталоге .github/ISSUE_TEMPLATE. Если шаблон создан в другой ветви, он не будет доступен для участников при совместной работе. В именах файлов шаблона проблемы не учитывается регистр, и для них требуется расширение .md. Чтобы включить его в контрольный список профилей сообщества, шаблоны проблем должны находиться в .github/ISSUE_TEMPLATE папке и содержать допустимые ключи в интерфейсном шаблоне YAML (для шаблонов проблем, определенных в .md файлах) или name: допустимых name: about: и description: ключей (для форм проблем, определенных в .yml файлах).

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

Вы можете создать политику безопасности, чтобы предоставить пользователям инструкции о том, как сообщать об уязвимостях системы безопасности в проекте. Дополнительные сведения см. в статье "Добавление политики безопасности в репозиторий".

Шаблоны запросов на вытягивание

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

Пример шаблона запроса на вытягивание

Вам необходимо создать шаблоны в ветви репозитория по умолчанию. Шаблоны, созданные в других ветвях, недоступны для участников при совместной работе. Шаблон запроса на вытягивание можно хранить в видимом корневом каталоге репозитория, папке docs или скрытом каталоге .github. В именах файлов шаблонов запросов на вытягивание не учитывается регистр, и они могут иметь такие расширения, как .md или .txt.

Дополнительные сведения см. в статье Создание шаблона запроса на вытягивание для репозитория.