Skip to main content

创建讨论类别表单

可以自定义社区成员在存储库中打开新讨论时可使用的模板。

关于讨论类别表单

在存储库中使用讨论表单可以鼓励社区成员在其讨论中包含特定的结构化信息。 通过讨论类别表单,可以创建具有可自定义 Web 表单字段的讨论模板。 讨论表单使用 GitHub 表单架构以 YAML 编写。 有关详细信息,请参阅“GitHub 表单架构的语法”。

如果你不熟悉 YAML 并且想要了解详细信息,请参阅“在五分钟内了解 YAML”。

要在仓库中使用讨论类别表单,必须创建一个新文件并将它添加到仓库中的 /.github/DISCUSSION_TEMPLATE/ 文件夹。

还可以为组织创建讨论类别表单。 有关详细信息,请参阅“创建默认的社区运行状况文件”。

投票不支持使用讨论类别表单。 有关投票的详细信息,请参阅“关于讨论”。

下面是议题表单的呈现版本。

呈现的讨论类别表单的屏幕截图。

创建讨论类别表单

对存储库具有写入权限的人员可以创建讨论类别窗体。

  1. 导航到要在其中创建讨论类别表单的存储库。
  2. 在存储库中,创建一个名为 /.github/DISCUSSION_TEMPLATE/FORM-NAME.yml 的文件,然后将 FORM-NAME 替换为讨论类别表单的名称。 该名称必须与某个讨论类别的数据域相对应。 例如,“公告”类别的模板应为 .github/DISCUSSION_TEMPLATE/announcements.yml。 有关在 GitHub 上创建新文件的详细信息,请参阅“创建新文件”。
  3. 在新文件的正文中,键入讨论类别表单的内容。 有关详细信息,请参阅“讨论类别表单的语法”。
  4. 将文件提交到仓库的默认分支。 有关详细信息,请参阅“创建新文件”。