Настройка шаблонов проблем для репозитория

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

Создание шаблонов проблем

1. На GitHub.com перейдите на главную страницу репозитория. 1. Под именем репозитория щелкните Параметры. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку Параметры.

   

2. В разделе "Компоненты" в разделе Проблемы щелкните Настройка шаблонов. Возможно, вам потребуется включить проблемы и обновить страницу, прежде чем вы увидите кнопку.

3. В раскрывающемся меню Добавить шаблон выберите тип шаблона, который вы хотите создать.

   

4. Чтобы просмотреть или изменить шаблон перед его фиксацией в репозитории, рядом с шаблоном щелкните Предварительный просмотр и изменение.

5. Чтобы изменить шаблон, щелкните и введите поля, чтобы изменить их содержимое.

   

6. Чтобы автоматически задать заголовок проблемы по умолчанию, назначьте проблему пользователям с доступом на чтение к репозиторию или примените метки к проблемам, поднятым из шаблона, используйте поля в разделе "Необязательные дополнительные сведения". Эти сведения также можно добавить в шаблон проблемы с помощью title, labels или assignees в формате титульного листа YAML.

7. Завершив редактирование и предварительный просмотр шаблона, нажмите кнопку Предложить изменения в правом верхнем углу страницы.

8. В поле Commit message (Сообщение о фиксации) введите сообщение фиксации, описывающее изменения.

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

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

Создание форм проблем

С помощью форм проблем можно создавать шаблоны проблем с настраиваемыми полями веб-формы. Вы можете стимулировать участников включать конкретные структурированные сведения с помощью форм проблем в вашем репозитории. Формы проблем создаются в YAML с помощью схемы формы GitHub. Дополнительные сведения см. в разделе Синтаксис для схемы формы GitHub. Если вы не знакомы с YAML и хотите узнать о нем подробнее, см. раздел Узнайте о YAML за Y минут.

Чтобы использовать форму проблем в репозитории, необходимо создать новый файл и добавить его в папку .github/ISSUE_TEMPLATE в этом репозитории.

Ниже приведен пример файла конфигурации формы проблем.

name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
  - octocat
body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: input
    id: contact
    attributes:
      label: Contact Details
      description: How can we get in touch with you if we need more info?
      placeholder: ex. email@example.com
    validations:
      required: false
  - type: textarea
    id: what-happened
    attributes:
      label: What happened?
      description: Also tell us, what did you expect to happen?
      placeholder: Tell us what you see!
      value: "A bug happened!"
    validations:
      required: true
  - type: dropdown
    id: version
    attributes:
      label: Version
      description: What version of our software are you running?
      options:
        - 1.0.2 (Default)
        - 1.0.3 (Edge)
    validations:
      required: true
  - type: dropdown
    id: browsers
    attributes:
      label: What browsers are you seeing the problem on?
      multiple: true
      options:
        - Firefox
        - Chrome
        - Safari
        - Microsoft Edge
  - type: textarea
    id: logs
    attributes:
      label: Relevant log output
      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
      render: shell
  - type: checkboxes
    id: terms
    attributes:
      label: Code of Conduct
      description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
      options:
        - label: I agree to follow this project's Code of Conduct
          required: true

Ниже приведена преобразованная для просмотра версия формы проблем.

1. Выберите репозиторий, в котором хотите создать форму проблем. Вы можете использовать существующий репозиторий, к которому у вас есть доступ для записи, или создать репозиторий. Дополнительные сведения о создании репозитория см. в разделе Создание репозитория.
2. В репозитории создайте файл с именем .github/ISSUE_TEMPLATE/FORM-NAME.yml, заменив FORM-NAME на имя вашей формы проблем. Дополнительные сведения о создании файлов на GitHub см. в разделе Создание новых файлов.
3. В тексте нового файла введите содержимое формы проблем. Дополнительные сведения см. в разделе Синтаксис для форм проблем.
4. Зафиксируйте этот файл в ветви по умолчанию вашего репозитория. Дополнительные сведения см. в разделе Создание новых файлов.

Настройка выбора шаблона

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

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

Если вы предпочитаете получать некоторые отчеты вне GitHub, то можете направлять людей на внешние сайты с помощью contact_links.

Ниже приведен пример файла config.yml.

blank_issues_enabled: false
contact_links:
  - name: GitHub Community Support
    url: https://github.com/orgs/community/discussions
    about: Please ask and answer questions here.
  - name: GitHub Security Bug Bounty
    url: https://bounty.github.com/
    about: Please report security vulnerabilities here.

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

1. На GitHub.com перейдите на главную страницу репозитория.

2. Над списком файлов выберите раскрывающееся меню Добавить файл , а затем щелкните Создать файл.

   Кроме того, можно щелкнуть в представлении дерева файлов слева.

   

3. В поле имени файла введите .github/ISSUE_TEMPLATE/config.yml.

4. В тексте нового файла введите содержимое вашего файла конфигурации.

5. Щелкните Зафиксировать изменения...

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

   1. Нажмите кнопку Зафиксировать изменения или Предложить изменения.

Дополнительные материалы

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