Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.

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

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

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

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

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

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

Снимок экрана: страница новой проблемы с несколькими шаблонами на выбор.

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

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

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

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

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

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

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

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

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

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

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