Gitee开源项目issue模板怎么写

一,目录和配置结构

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

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

注意

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

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:跳转外部网站的描述说明

三,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 目录

五,Issue 模板参考样例

可以浏览该项目查看相关配置:

FastBee: FastBee开源物联网平台,简单易用,更适合中小企业和个人学习使用。适用于智能家居、智慧办公、智慧社区、农业监测、水利监测、工业控制等。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/433212.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

face_recognition和图像处理中left、top、right、bottom解释

face_recognition.face_locations 介绍 加载图像文件后直接调用face_recognition.face_locations(image),能定位所有图像中识别出的人脸位置信息,返回值是列表形式,列表中每一行是一张人脸的位置信息,包括[top, right, bottom, l…

SQL注入:报错注入

SQL注入系列文章:初识SQL注入-CSDN博客 SQL注入:联合查询的三个绕过技巧-CSDN博客 目录 什么是报错注入? 报错注入常用的3个函数 UpdateXML ExtractValue Floor rand(随机数) floor(向上取整&…

项目性能优化之用compression-webpack-plugin插件开启gzip压缩

背景:vue项目打包发布后,部分js、css文件体积较大导致页面卡顿,于是使用webpack插件compression-webpack-plugin开启gzip压缩 前端配置vue.config.js 先通过npm下载compression-webpack-plugin包,npm i compression-webpack-plug…

服务器基础知识(IP地址与自动化技术的使用)

目录 ip地址是什么? 如何查看ip地址 Windows的命令提示符 图形化版本: 自动化技术的应用与意义 ip地址是什么? IP地址的主要作用是**为互联网上的每个网络和每台主机分配一个逻辑地址**。 它由32位二进制数字组成,通常分为四…

微信小程序(十七)自定义组件生命周期(根据状态栏自适配)

注释很详细,直接上代码 上一篇 新增内容: 1.获取手机状态栏的高度 2.验证attached可以修改数据 3.动态绑定样式数值 源码: myNav.js Component({lifetimes:{//相当于vue的created,因为无法更新数据被打入冷宫created(){},//相当于vue的mount…

Docker数据卷挂载(以容器化Mysql为例)

数据卷 数据卷是一个虚拟目录,是容器内目录与****之间映射的桥梁 在执行docker run命令时,使用**-v 本地目录:容器目录**可以完成本地目录挂载 eg.Mysql容器的数据挂载 1.在根目录root下创建目录mysql及三个子目录: cd ~ pwd m…

2982. 找出出现至少三次的最长特殊子字符串 II

字典树思路 用字典树搞一下就好了&#xff0c;比如aaaaa &#xff1a; a存5次 aa 4次以此类推&#xff5e; 字典树板子复习&#xff1a;P8306 【模板】字典树 这里这个清空方式 很好 因为很多时候memset T #include<iostream> #include<cstring> using namesp…

TensorFlow2实战-系列教程2:神经网络分类任务

&#x1f9e1;&#x1f49b;&#x1f49a;TensorFlow2实战-系列教程 总目录 有任何问题欢迎在下面留言 本篇文章的代码运行界面均在Jupyter Notebook中进行 本篇文章配套的代码资源已经上传 1、Mnist数据集 下载mnist数据集&#xff1a; %matplotlib inline from pathlib imp…

蓝桥杯省赛无忧 编程13 肖恩的投球游戏

#include <iostream> #include <vector> using namespace std; int main() {int n, q;cin >> n >> q;vector<int> a(n 1);vector<int> diff(n 2, 0); // 初始化差分数组// 读取初始球数&#xff0c;构建差分数组for (int i 1; i < …

Redis 击穿、穿透、雪崩产生原因解决思路

大家都知道&#xff0c;计算机的瓶颈之一就是IO&#xff0c;为了解决内存与磁盘速度不匹配的问题&#xff0c;产生了缓存&#xff0c;将一些热点数据放在内存中&#xff0c;随用随取&#xff0c;降低连接到数据库的请求链接,避免数据库挂掉。需要注意的是&#xff0c;无论是击穿…

IDEA 安装阿里Java编码规范插件

1.File>Settings 2.安装之后重启 开发过程中如果有不符合规范的地方&#xff0c;会自动出现提示

硬件知识(1) 手机的长焦镜头

#灵感# 手机总是配备好几个镜头&#xff0c;研究一下 目录 手机常配备的摄像头&#xff0c;及效果举例 长焦的焦距 焦距的定义和示图&#xff1a; IPC的焦距和适用场景&#xff1a; 手机常配备的摄像头&#xff0c;及效果举例 以下是小米某个手机的摄像头介绍&#xff1a…