Gitee开源项目issue模板怎么写

一，目录和配置结构

itee Issue 模板配置存储于仓库的默认分支下 .gitee/ISSUE_TEMPLATE 隐藏目录中。

以下是一个完整 Issue 模板配置和对应的目录结构参考：

Gitee开源项目issue模板怎么写-LMLPHP

注意

如果你在另一个分支中创建模板，配置将不会生效，相关的功能协作用户将无法使用该功能。

Issue 模板文件名不区分大小写，文件以 .md / .yml / .yaml 扩展名结尾，其中：

.md 文件用于普通（传统）的 Issue 模板和 Issue 空白模板使用。
.yml / .yaml 文件用于 Issue 模板中自动指派功能和表单项配置使用。

当使用 YAML 格式的 Gitee Issue 模板功能时，相关配置由以下两部分组成：

模板选择器：文件名为 config.yml，用于自定义用户在仓库新建 Issue 时看到的模板选择器。
Issue 模板表单配置：YAML 配置文件，结合 Gitee 表单范式 (Gitee’s Form Schema) 配置定义 Issue 正文，用于定义具体 Issue 的表单内容。

二，模板选择器配置（`config.yml`）

通过在默认分支 .gitee/ISSUE_TEMPLATE 目录添加 config.yml 文件，可以自定义扩充 Issue 模板列表的内容。

以下是使用 config.yml 自定义 Issue 模板列表选择项的示例：

blank_issues_enabled: false
contact_links:
  - name: Gitee 帮助中心
    url: https://help.gitee.com/
    about: 提供 Git 使用指南、教程、Gitee.com 平台基本功能使用、介绍和常见问题解答

具体字段释义如下：

blank_issues_enabled：你可通过将 blank_issues_enabled 设置为 false 来鼓励用户使用 Issue 模板（不允许用户创建空白 Issue）。如果你将 blank_issues_enabled 设置为 true，则用户可以选择打开并创建一个空白的 Issue。
contact_links：如果你希望在 Gitee 之外接收某些报告，或引导用户浏览相关文档，可使用 contact_links 将用户引导到外部网站。
- name：外部网站名称
- url：跳转的外部网站目标地址
- about：跳转外部网站的描述说明

Gitee开源项目issue模板怎么写-LMLPHP

三，Issue 模板配置字段

模板配置支持预设默认指派的用户和标签 (label)，支持自定义表单类型（输入/下拉/单选/多选/代码块等），并设置表单项是否必填。以下是 Issue 模板配置的示例：

name: 功能建议
description: 对本项目提出一个功能建议
title: "[功能建议]: "
labels: ["enhancement"]
assignees:
  - gitee
body:
    ...

具体字段释义如下：

name：模板名称，必填项，用于定义模板的名称
description：模板描述，必填项，用于解释模板的用途
title：可选项，预设填充的 Issue 标题前缀。
labels：可选项，预设指定关联的标签（label），使用逗号分隔。在 Issue 创建同时为 Issue 关联指定的标签（label）仅针对仓库下存在的标签有效。当指定的 label 不存在时，默认忽略。
assignees：可选项，预设被指派用户的用户名，使用列表或使用逗号分隔。在 Issue 创建同时将 Issue 指派给具体用户。被指派用户必须存在于仓库名单，当被指派的用户不在仓库成员名单内，默认忽略。
body：必填列表项，Issue 模板表单配置，使用 Gitee 表单范式 (Gitee’s Form Schema) 进行定义。

四，模板功能兼容说明

Gitee Issue 模板 兼容 GitHub Issue Template，同时兼容以下目录的识别（识别优先顺序从上到下）：

当前仓库默认分支上的 .gitee/ISSUE_TEMPLATE 目录
当前仓库默认分支上的 .github/ISSUE_TEMPLATE 目录
与仓库同一空间下的 .gitee 仓库
- 默认分支上的 .gitee/ISSUE_TEMPLATE 目录
- 默认分支上的 .github/ISSUE_TEMPLATE 目录

帐篷Li