Skip to main content

Enterprise Server 3.20 в настоящее время доступен в качестве кандидата на выпуск.

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

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

В этой статье

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

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

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

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

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

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

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

С помощью форм проблем можно создавать шаблоны с полями веб-формы с помощью схемы формы GitHub. Когда участник открывает проблему с помощью формы проблемы, входные данные формы преобразуются в стандартный комментарий о проблеме Markdown. Вы можете указать различные типы входных данных и задать входные данные в соответствии с требованиями, чтобы помочь участникам открывать в репозитории проблемы с действиями. Дополнительные сведения см. в разделе [AUTOTITLE и Настройка шаблонов проблем для репозитория](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms).

данных repositories.issue-template-config %} Дополнительные сведения см. в разделе Настройка шаблонов проблем для репозитория.

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

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

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

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

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

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