问题表单语法

你可以为问题表单定义不同的输入类型、验证、默认指派人和默认标签。

本文内容

注意：问题表单当前处于测试阶段，并可能发生更改。

关于问题表单的 YAML 语法

可以通过将 YAML 表单定义文件添加到存储库中的 /.github/ISSUE_TEMPLATE 文件夹来创建自定义问题表单。如果您不熟悉 YAML 并希望了解更多信息，请参阅“用 Y 分钟学习 YAML”。您可以为问题表单定义不同的输入类型、验证、默认分配者和默认标签。

当贡献者填写问题表单时，他们对每个输入的响应将转换为 markdown 并添加到问题的正文中。贡献者可以编辑使用问题表单创建的问题，其他人可以像通过其他方法创建的问题一样与问题进行交互。

不支持对请求提取进行问题表单。您可以在存储库中创建请求提取模板，供协作者使用。有关更多信息，请参阅“为您的存储库创建请求提取模板”。

此示例 YAML 配置文件使用多个输入定义了一个问题表单，用于报告错误。

注意：在公共存储库中仅支持 required 字段键。在私有和内部存储库中，所有字段都是可选的。

YAML
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug", "triage"]
projects: ["octo-org/1", "octo-org/44"]
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 protected]
    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)
      default: 0
    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

顶级语法

所有问题表单配置文件都必须以 name、description 和 body 键值对开头。

YAML
name:
description:
body:

您可以为每个问题表单设置以下顶级键。

键说明必需类型
name问题表单模板的名称。必须与所有其他模板（包括 Markdown 模板）唯一。必需字符串
description问题表单模板的说明，显示在模板选择器界面中。必需字符串
body表单中输入类型的定义。必需数组
assignees将自动分配给使用此模板创建的问题的人员。可选数组或逗号分隔的字符串
labels将自动添加到使用此模板创建的问题的标签。如果标签在存储库中不存在，则不会自动将其添加到问题中。可选数组或逗号分隔的字符串
title将在问题提交表单中预先填充的默认标题。可选字符串
项目使用此模板创建的任何问题都会自动添加到此项目中。此键的格式为 PROJECT-OWNER/PROJECT-NUMBER。
注意：打开问题的人员必须具有指定项目的写入权限。如果您不希望使用此模板的人员具有写入权限，请考虑启用项目的自动添加工作流。有关详细信息，请参阅“自动添加项目”。
可选数组或逗号分隔的字符串

有关可用的 body 输入类型及其语法，请参阅“GitHub 表单架构的语法”。

将 Markdown 问题模板转换为 YAML 问题表单模板

可以在存储库中同时使用 Markdown 和 YAML 问题模板。如果您要将 Markdown 问题模板转换为 YAML 问题表单模板，则必须创建一个新的 YAML 文件来定义问题表单。您可以手动将现有的 Markdown 问题模板转置为 YAML 问题表单。有关详细信息，请参阅“为存储库配置问题模板”。

如果您想为 YAML 问题表单使用相同的文件名，则必须在将新文件提交到存储库时删除 Markdown 问题模板。

下面是 Markdown 问题模板和相应的 YAML 问题表单模板的示例。

Markdown 问题模板

Markdown
---
name: 🐞 Bug
about: File a bug/issue
title: '[BUG] <title>'
labels: Bug, Needs Triage
assignees: ''

---

<!--
Note: Please search to see if an issue already exists for the bug you encountered.
-->

### Current Behavior:
<!-- A concise description of what you're experiencing. -->

### Expected Behavior:
<!-- A concise description of what you expected to happen. -->

### Steps To Reproduce:
<!--
Example: steps to reproduce the behavior:
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
-->

### Environment:
<!--
Example:
- OS: Ubuntu 20.04
- Node: 13.14.0
- npm: 7.6.3
-->

### Anything else:
<!--
Links? References? Anything that will give us more context about the issue that you are encountering!
-->

YAML 问题表单模板

YAML
name: 🐞 Bug
description: File a bug/issue
title: "[BUG] <title>"
labels: ["Bug", "Needs Triage"]
body:
- type: checkboxes
  attributes:
    label: Is there an existing issue for this?
    description: Please search to see if an issue already exists for the bug you encountered.
    options:
    - label: I have searched the existing issues
      required: true
- type: textarea
  attributes:
    label: Current Behavior
    description: A concise description of what you're experiencing.
  validations:
    required: false
- type: textarea
  attributes:
    label: Expected Behavior
    description: A concise description of what you expected to happen.
  validations:
    required: false
- type: textarea
  attributes:
    label: Steps To Reproduce
    description: Steps to reproduce the behavior.
    placeholder: |
      1. In this environment...
      1. With this config...
      1. Run '...'
      1. See error...
  validations:
    required: false
- type: textarea
  attributes:
    label: Environment
    description: |
      examples:
        - **OS**: Ubuntu 20.04
        - **Node**: 13.14.0
        - **npm**: 7.6.3
    value: |
        - OS:
        - Node:
        - npm:
    render: markdown
  validations:
    required: false
- type: textarea
  attributes:
    label: Anything else?
    description: |
      Links? References? Anything that will give us more context about the issue you are encountering!

      Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
  validations:
    required: false

延伸阅读