Gitee开源项目issue模板怎么写

这篇具有很好参考价值的文章主要介绍了Gitee开源项目issue模板怎么写。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

一,目录和配置结构

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

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

Gitee开源项目issue模板怎么写,开源社区建设,gitee,开源,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:跳转外部网站的描述说明

Gitee开源项目issue模板怎么写,开源社区建设,gitee,开源,issue

三,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开源物联网平台,简单易用,更适合中小企业和个人学习使用。适用于智能家居、智慧办公、智慧社区、农业监测、水利监测、工业控制等。文章来源地址https://www.toymoban.com/news/detail-819918.html

到了这里,关于Gitee开源项目issue模板怎么写的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Github、Gitee优秀的开源项目

    收集 Github 、 Gitee 优秀的开源项目,并进行归类整理。项目地址 编程语言项目 SprinBoot 项目 源码分析项目 前后端分离项目 Vue2 项目 Vue3 项目 微服务项目 Api 网关项目 中间件项目 数据操作项目 测试运维监控项目 接口文档管理项目 知识管理项目 聊天项目 工具项目 集合项目

    2023年04月14日
    浏览(53)
  • Github、Gitee优秀的开源项目分享

    先赞后看,养成习惯!!!❤️ ❤️ ❤️ 资源收集不易,如果喜欢可以关注我哦! ​如果本篇内容对你有所启发,欢迎访问我的个人博客了解更多内容:链接地址 ​ javacore  -  Java  核心技术的经验总结。 在线文档 symphony  - 一款用  Java  实现的现代化 社区(论坛/问答

    2024年02月04日
    浏览(45)
  • github gitee go开发 热门开源项目

    (1)尽可能的使用:=去初始化声明一个变量(在函数内部) (2)尽可能的使用字符代替字符串 (3)尽可能的使用切片代替数组 (4)尽可能的使用数组和切片代替映射 (5)如果只想获取切片中某项值,不需要值的索引,尽可能的使用for range去遍历切片,这比必须查询切片

    2024年02月10日
    浏览(47)
  • SOFA Weekly|开源之夏 MOSN 与 Layotto 项目简介、社区会议预告、社区本周贡献

     SOFA WEEKLY | 每周精选   筛选每周精华问答,同步开源进展 欢迎留言互动~ SOFA Stack( S calable  O pen  F inancial  A rchitecture Stack)是蚂蚁集团自主研发的金融级云原生架构,包含了构建金融级云原生架构所需的各个组件,包括微服务研发框架,RPC 框架,服务注册中心,分布式

    2024年02月06日
    浏览(48)
  • 前端(十八)——gitee上开源一个移动端礼盒商城项目(前端+后台)

    🤗博主:小猫娃来啦 🤗文章核心: gitee上开源一个移动端礼盒商城项目 项目样式老旧,ui设计较low,虽说现在大众的商城app都使用的是瀑布流布局,且功能更丰富。但本项目仅作为开源学习和技术交流,仅此而已。 前端采用搭建vue脚手架处理,使用JavaScript语言,后台采用

    2024年02月08日
    浏览(43)
  • 前端(十七)——gitee上开源一个移动端礼盒商城项目(前端+后台)

    🤗博主:小猫娃来啦 🤗文章核心: gitee上开源一个移动端礼盒商城项目 项目样式老旧,ui设计较low,虽说现在大众的商城app都使用的是瀑布流布局,且功能更丰富。但本项目仅作为开源学习和技术交流,仅此而已。 前端采用搭建vue脚手架处理,使用JavaScript语言,后台采用

    2024年02月09日
    浏览(39)
  • 怎么从码云(gitee)下载项目到IDEA运行

            如果我们直接从码云克隆/下载项目,发现在Idea上运行时是行不通的!怎么办呢?请往下看:  一、在官网下载Git Bash  二、创建一个空文件夹          首先创建一个空文件夹   三、使用git clone url命令下载在文件夹          右击创建的空文件,找到Git Bash He

    2023年04月19日
    浏览(38)
  • 手摸手教你Vite+Vue3项目初始化及开源部署到GItee

    本片文章主要记录项目的环境,项目搭建。 在开始本次学习中,鉴于你有前端三件套和vue的知识基础。 文档创建于2023年5月20日,大家都去过情人节了~我在肝代码! 环境的搭建 node版本使用18.16.0。 目前(2023.05.20)的稳定版本,这里推荐使用nvm来管理node的版本。Nvm使用教程

    2024年02月04日
    浏览(56)
  • ❤ React18 环境搭建项目与运行(地址已经放Gitee开源--新体系为webpack搭建)

    记得给个star呀伙伴 Github(https://github.com/NexusLin/NexusReact) Gitee(https://gitee.com/NexusLinNoa/NexusReact) 环境介绍 1、检查本地环境 node版本 18.17.0 检查node和npm环境 node -v npm -v 2、安装yarn npm install -g yarn yarn --version 3、创建一个新的React项目 npx create-react-app ltbreact 4、进入并运行项目

    2024年04月13日
    浏览(36)
  • IDEA中怎么使用git下载项目到本地,通过URL克隆项目(gitee\github)

    == 通过URL拉取项目代码== gitee github也是一样的 返回IDEA 将刚刚复制的URL粘贴进去 选择合适的位置 点击克隆

    2024年02月14日
    浏览(71)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包