diff --git a/.github/ISSUE_TEMPLATE/BugReport.yml b/.github/ISSUE_TEMPLATE/BugReport.yml new file mode 100644 index 0000000..3c6b18b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BugReport.yml @@ -0,0 +1,92 @@ +name: Bug 反馈 +description: 在使用 CRSim 的过程中遇到了 Bug。 +title: (将此栏【替换】为你的标题) +labels: ["Bug", "待查看", "优先级:无"] +type: Bug +body: + - type: markdown + attributes: + value: | + 感谢您进行 Bug 反馈。请在上面的文本框⬆️起一个能够清晰描述您的问题的标题,便于开发者解决您的问题。 + + > [!important] + > 重要:如果要提出**多个 Bug**,请为每一个 Bug 开一个单独的 issue。 + > + > 如果您不知道如何有效、精准地表述,我们建议您先阅读《提问的智慧》([链接](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md))。 + + - type: checkboxes + id: checklist + attributes: + label: 检查清单 + description: 在开始反馈这个问题之前,请先检查: + options: + - label: 我已更新到最新版 ![最新的版本号](https://img.shields.io/github/v/release/denglihong2007/CRSim?include_prereleases&style=flat-square&label=) 或 ![最新的版本号](https://img.shields.io/github/v/release/denglihong2007/CRSim?style=flat-square&label=) 测试,并看过 [最新提交](https://github.com/denglihong2007/CRSim/commits/dev/),确认这一 Bug 还没有修复。我也已在 [Issues](https://github.com/denglihong2007/CRSim/issues?q=type%3ABug) 中检索,确认这一 Bug 未被提交过。 + required: true + - label: 我已经仔细阅读过选项里的内容,并且知道这个选项不用勾选。 + - label: 我已知晓并同意,此处仅用于汇报程序中存在的问题(关于其他非程序本身的问题应当在 Discussion 板块提出)。 + required: true + - type: markdown + attributes: + value: | + ### Bug 信息 + + 描述您遇到的 Bug。您可以附上截图、录屏、堆栈跟踪、日志等材料,便于开发者追踪问题。 + + > [!note] + > 上传附件时**请优先使用 GitHub 的附件系统上传附件**,将需要上传的附件粘贴或拖动到撰写区域即可上传。多个文件可打包为 zip 格式后上传。**尽量避免使用需要登陆或安装客户端才能接收附件的网盘(如\*度网盘、\*克网盘、1\*3网盘等)上传附件**,以避免开发者因不具有对应网盘客户端或账户而延误问题诊断。 + - type: textarea + id: excepted + attributes: + label: 期望的行为 + description: 详细的描述你期望发生的行为,突出与目前(可能不正确的)行为的不同。 + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: 实际结果 + description: 实际发生的行为。 + validations: + required: true + - type: textarea + id: reproduce-steps + attributes: + label: 重现步骤 + description: | + 详细描述要怎么操作才能再次触发这个 Bug。 + placeholder: | + 1. 首先…… + 2. 然后…… + 3. …… + validations: + required: true + - type: textarea + id: stacktrace + attributes: + label: 堆栈跟踪(可选) + description: 如果在遇到这个 Bug 时发生了崩溃(弹出崩溃提示),或者产生了错误日志,请将产生的堆栈跟踪信息粘贴到此处,便于开发者定位 Bug。 + render: shell + - type: input + id: app_version + attributes: + label: 应用版本 + description: 您当前使用的 CRSim 版本号,可以在【设置】->【关于 CRSim】中查看。 + placeholder: 如:2.3.102.0 + validations: + required: true + - type: input + id: os_version + attributes: + label: 操作系统版本 + description: | + 您当前使用的 Windows 操作系统版本,可以运行 `winver.exe` 查看。 + 如果您不能肯定此 Bug 与操作系统无关,请填写此项。 + placeholder: 如:10.0.22000.0 + - type: checkboxes + id: revision + attributes: + label: 最后一步 + description: 回顾您的回答 + options: + - label: 我认为上述的描述已经足以详细,以允许开发人员能复现该问题。如果我的 issue 没有按照上述的要求填写,可能会被无条件关闭。 + required: true diff --git a/.github/ISSUE_TEMPLATE/FeatureRequest.yml b/.github/ISSUE_TEMPLATE/FeatureRequest.yml new file mode 100644 index 0000000..fdb0e66 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FeatureRequest.yml @@ -0,0 +1,57 @@ +name: 功能请求 +description: 提出一项新的功能。 +title: (将此栏【替换】为你的标题) +labels: ["新功能", "待查看", "优先级:无"] +type: 特性 +body: + - type: markdown + attributes: + value: | + 感谢您贡献您的想法。请在上面的文本框⬆️起一个能够清晰概括此功能的标题,便于开发者了解您的想法。 + + > [!important] + > 重要:如果您想要提出 **多项功能**,请为每一个功能开一个单独的 issue。 + > + > 在提出功能请求前,**一定要看一看[贡献指南](https://github.com/ClassIsland/ClassIsland/blob/master/CONTRIBUTING.md#%E6%8F%90%E4%BA%A4%E5%8A%9F%E8%83%BD%E8%AF%B7%E6%B1%82) 中提交功能请求相关的部分!** + > + > 由于开发者时间精力有限,加上已经积压了大量的功能请求,提交的功能请求可能需要比较久的时间才能实现。 + - type: checkboxes + id: checklist + attributes: + label: 检查清单 + description: 在开始反馈这个问题之前,请先检查: + options: + - label: 我已将本应用更新到最新测试版 ![最新的版本号](https://img.shields.io/github/v/release/ClassIsland/ClassIsland?include_prereleases&style=flat-square&label=),并看过 [最新提交](https://github.com/ClassIsland/ClassIsland/commits/dev/),确认我想要的功能还没有实现。我也已在 [Issues](https://github.com/ClassIsland/ClassIsland/issues?q=-label%3ABug) 和 [ClassIsland 文档](https://docs.classisland.tech/app/) 中检索,确认我想要的功能未被提交过。 + required: true + - label: 我认为我想要的功能是用户广泛需要的,插件不能替代的,且没有超出 ClassIsland 作为**灵动课表**的开发目标,而非添加与课表及教学辅助无关的内容。(您可以学习 [编写插件](https://docs.classisland.tech/dev/plugins/create-project) 来实现特殊的需求)。 + required: true + - label: 我已经仔细阅读过选项里的内容,并且知道这个选项不用勾选。 + - label: 我已知晓由于开发者时间精力有限,加上已经积压了大量的功能请求,我提交的功能请求可能需要比较久的时间才能实现。 + required: true + - type: markdown + attributes: + value: | + > [!note] + > 上传附件时**请优先使用 GitHub 的附件系统上传附件**,将需要上传的附件粘贴或拖动到撰写区域即可上传。多个文件可打包为 zip 格式后上传。**尽量避免使用需要登陆或安装客户端才能接收附件的网盘(如\*度网盘、\*克网盘、1\*3网盘等)上传附件**,以避免开发者因不具有对应网盘客户端或账户而延误问题诊断。 + - type: textarea + id: back + attributes: + label: 背景与动机 + description: 为什么你需要这个功能?这个功能对你和其他用户有多重要? + validations: + required: true + - type: textarea + id: req + attributes: + label: 想要实现或优化的功能 + description: 详细地描述一下你想要的功能,描述的越具体,采纳的可能性越高。 + validations: + required: true + - type: checkboxes + id: revision + attributes: + label: 最后一步 + description: 回顾您的回答 + options: + - label: 我认为上述的描述已经足以详细,以便开发人员理解您想要的功能。如果我的 issue 没有按照上述的要求填写,可能会被无条件关闭。 + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..9b02d67 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 讨论区 + url: https://github.com/denglihong2007/CRSim/discussions/ + about: 使用中若遇到问题或有新点子新需求,请先在这里求助和征求意见。 \ No newline at end of file