diff --git a/.github/ISSUE_TEMPLATE/BugReport.yml b/.github/ISSUE_TEMPLATE/BugReport.yml new file mode 100644 index 0000000..ad96224 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BugReport.yml @@ -0,0 +1,89 @@ +name: Bug 反馈 +description: 在使用考试看板 Next 的过程中遇到了 Bug。 +title: （在这里输入你的标题） +labels: ['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/ProjectCampus-CH/dsz-exam-showboard-next?include_prereleases&style=flat-square&label=) ，并看过[最新提交](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/commits/dev/)，确认这一 Bug 还没有修复。 + required: true + - label: 我已在 [Issues](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/issues?q=label%3ABug) 中检索，确认这一 Bug 未被提交过。 + required: true + - label: 我已知晓并同意，此处仅用于汇报程序中存在的问题（关于其他非程序本身的问题应当在 Discussion 板块提出）。 + required: true + - type: markdown + attributes: + value: | + ### Bug 信息 + + 描述您遇到的 Bug。您可以附上截图、录屏、堆栈跟踪、日志等材料，便于开发者追踪问题。 + - 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: 您当前使用的考试看板 Next 版本号，可以在【关于】中查看。 + placeholder: 如：1.1.1 + 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..1851a70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FeatureRequest.yml @@ -0,0 +1,48 @@ +name: 功能请求 +description: 提出一项新的功能。 +title: （在这里输入你的标题） +labels: ['新功能'] +body: + - type: markdown + attributes: + value: | + 感谢您贡献您的想法。请在上面的文本框⬆️起一个能够清晰概括此功能的标题，便于开发者了解您的想法。 + + > [!important] + > 重要：如果您想要提出 **多项功能**，请为每一个功能开一个单独的 issue。 + - type: checkboxes + id: checklist + attributes: + label: 检查清单 + description: 在开始反馈这个问题之前，请先检查： + options: + - label: 我已将本应用更新到最新测试版 ![最新的版本号](https://img.shields.io/github/v/release/ProjectCampus-CH/dsz-exam-showboard-next?include_prereleases&style=flat-square&label=)，并看过[最新提交](https://github.com/ClassIsland/ClassIsland/commits/dev/)，确认我想要的功能还没有实现。 + required: true + - label: 我已在 [Issues](https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/issues?q=label%3A新功能) 确认我想要的功能未被提交过。 + required: true + - label: 我认为我想要的功能是用户广泛需要的，插件不能替代的，且没有超出考试看板 Next 的开发目标，而非添加与课表及教学辅助无关的内容。（您可以学习[编写插件](https://docs.classisland.tech/zh-cn/latest/dev/plugins/create-project/)来实现特殊的需求）。 + required: true + - label: 我已知晓由于开发者时间精力有限，加上已经积压了大量的功能请求，我提交的功能请求可能需要比较久的时间才能实现。 + required: true + - 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..f259687 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 讨论区 + url: https://github.com/ProjectCampus-CH/dsz-exam-showboard-next/discussions + about: 使用中若遇到问题或有新点子新需求，请先在这里求助和征求意见。 diff --git a/README.md b/README.md index e70d782..82c50ea 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ ExamShowboard logo # 考试看板Next（原DSZ考试看板） + # DSZ-Exam-Showboard-Next
@@ -15,7 +16,7 @@ [![Github Last Commit](https://img.shields.io/github/last-commit/MKStoler4096/dsz-exam-showboard-next)](https://github.com/MKStoler4096/dsz-exam-showboard-next/commits/master) [![GitHub Language Count](https://img.shields.io/github/languages/count/MKStoler4096/dsz-exam-showboard-next)](https://github.com/MKStoler4096/dsz-exam-showboard-next) [![GitHub Top Language](https://img.shields.io/github/languages/top/MKStoler4096/dsz-exam-showboard-next)](https://github.com/MKStoler4096/dsz-exam-showboard-next) -[![LICENSE](https://img.shields.io/badge/License-GPL--3.0-red.svg "LICENSE")](LICENSE) +[![LICENSE](https://img.shields.io/badge/License-GPL--3.0-red.svg 'LICENSE')](LICENSE) [![QQ群](https://img.shields.io/badge/-QQ%E7%BE%A4%EF%BD%9C901670561-blue?style=flat&logo=TencentQQ&logoColor=white)](https://qm.qq.com/q/zDiEipHsaI) ![WelcomePage](/.Screenshots/WelcomePage.jpg) @@ -24,20 +25,20 @@ 一款显示当前时间与考试详细信息的看板类软件 | 下载 | [Releases](https://github.com/MKStoler4096/dsz-exam-showboard-next/releases) | [Actions](https://github.com/MKStoler4096/dsz-exam-showboard-next/actions) | -| - | - | - | +| ---- | ---------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
-> [!tip] -> **本软件使用`Vue` + `TypeScript` + `JavaScript`制作，使用`Node.js` + `Electron`完善系统级功能并打包。** +> [!tip] > **本软件使用`Vue` + `TypeScript` + `JavaScript`制作，使用`Node.js` + `Electron`完善系统级功能并打包。** ## 功能 + - 起始页展示`打开配置`、`直接进入看板`按钮 - 看板页面 - - 上方展示`考试标题`、`信息` - - 左侧展示`当前时间`、`当前科目`、`考试时间`、`考试状态` - - 右侧展示考试科目列表，包括`科目`、`开始`、`结束`、`状态` - - 考试结束前15分钟黄字提醒 + - 上方展示`考试标题`、`信息` + - 左侧展示`当前时间`、`当前科目`、`考试时间`、`考试状态` + - 右侧展示考试科目列表，包括`科目`、`开始`、`结束`、`状态` + - 考试结束前15分钟黄字提醒 ## 开始使用 @@ -48,26 +49,27 @@ - 编写`json`配置文件 新建文件`exam_config.json`，模板如下 + ```json { - "examName": "考试名称", - "message": "信息", - "examInfos": [ - { - "name": "科目", - "start": "2024-10-01T07:00:00", - "end": "2024-10-01T08:00:00" - }, - { - "name": "科目", - "start": "2024-10-01T09:00:00", - "end": "2024-10-01T10:00:00" - } - ] + "examName": "考试名称", + "message": "信息", + "examInfos": [ + { + "name": "科目", + "start": "2024-10-01T07:00:00", + "end": "2024-10-01T08:00:00" + }, + { + "name": "科目", + "start": "2024-10-01T09:00:00", + "end": "2024-10-01T10:00:00" + } + ] } ``` -- 打开软件，进入起始页面，点击`打开配置`按钮，选择配置文件，下次可点击`直接进入看板`按钮，将继续使用上次加载的配置。 +- 打开软件，进入起始页面，点击`打开配置`按钮，选择配置文件，下次可点击`直接进入看板`按钮，将继续使用上次加载的配置。 ## 遇到问题 @@ -83,8 +85,7 @@ - [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) -> [!Caution] -> **必须使用Yarn包管理。Node版本要求为20。** +> [!Caution] > **必须使用Yarn包管理。Node版本要求为20。** ### Project Setup @@ -119,8 +120,7 @@ $ yarn build:linux - 正在[`dev`](https://github.com/MKStoler4096/dsz-exam-showboard-next/commits/dev)分支上开发`1.2-Yesod`版本。 -> [!note] -> **如果dev模式页面不显示或按钮点击无效等问题，请连续刷新至少3次后再进行操作。build后没有此问题。** +> [!note] > **如果dev模式页面不显示或按钮点击无效等问题，请连续刷新至少3次后再进行操作。build后没有此问题。** ## Stars 历史