有了它,我两岁的孩子都能提个好 Issue

289 阅读2分钟

省流:Gitee 现已支持 Issue 使用表单提交。

image.png

怎么配置?看下面

配置 Issue 目录与结构

如果你想要设置 Issue 模版,首先需要配置模板的目录。

Gitee Issue 模板配置存储于仓库的默认分支下 .gitee/ISSUE_TEMPLATE 隐藏目录中(如仓库下没有该目录需新建)。

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

├── .gitee  # 兼容 .github 目录(优先选择 .gitee 目录)
│   ├── ISSUE_TEMPLATE    # Issue 模板配置目录
│   │   ├── feature.yml   # 适用于 Feature 建议的 Issue 表单模板
│   │   ├── bug.yml       # 适用于 Bug 反馈的 Issue 表单模板
│   │   └── config.yaml   # 模板选择器配置
│   └── issue_template.md # Issue 空白模板(可选)
├── LICENSE
├── ...
└── README.md

.gitee/ISSUE_TEMPLATE目录配置好后,就可以进行配置 Issue 表单的工作了。

配置 Issue 表单内容

Issue 表单的模板与配置均以YAML文件的形式存放在ISSUE_TEMPLATE目录下,可大致分为模板选择器配置config.yml和自定义 Issue 模板bug/feature/….yml

模板选择器配置

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

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

blank_issues_enabled: false # 不允许用户创建空白 Issue
contact_links:
    - name: 遇到问题先去看文档!谢谢! # 外部网站名称
      url: https://help.xxx.com/ # 跳转的外部网站目标地址
      about: 文档可以解决你80%的疑惑 # 跳转外部网站的描述说明

配置好config.yml后的效果如下(无法单独配置,需结合 Issue 模板使用):

image.png

Issue 模板配置

你可以高度自定义 Issue 模版的配置,包括默认指派的用户和标签 (label)、自定义表单类型(输入/下拉/单选/多选/代码块等)、设置表单项是否必填等

以下是 Issue 模板配置的示例:

name: 让我逮到 Bug 了!# 模板名称,必填项,用于定义模板的名称
description: 捐赠项目可提升 Bug 修复速度 # 模板描述,必填项,用于解释模板的用途
title: "[Bug]: " # 可选项,预设填充的 Issue 标题前缀。
labels: ["bug"] # 可选项,预设指定关联的标签(label)
assignees: # 可选项,预设被指派用户的用户名
  - gitee
body: # 必填列表项,Issue 模板表单配置
    ...

配置完成的 Issue 页面如下图:

image.png

更丰富的 Issue 模版样例以及 Gitee 表单范式请查看相关帮助文档

体验优雅的 Issue 处理

将你所需要的 Issue 模板配置完成后,项目相关人员就可以根据你的配置提交 Issue了。

issue.gif

通过模版提交的 Issue,会根据模板中的相应配置展示出来,更加清晰易懂,解决起来当然更加得心应手。

image.png

我们也相信,凭借高度自定义的特性,Issue 模板还有更多可玩性等着开发者们去发掘,你有什么更好玩的点子吗?告诉我们吧!