Browse Source

Refactor issue (#707)

* feat: refactor issue bug feedback

* fix: directory structure of the issue media folder

* feat: refactor issue feature request

* feat: refactor issue

* fix: issue

---------

Co-authored-by: DDSRem <[email protected]>
DDSDerek 2 years ago
parent
commit
2094711a2e

+ 0 - 22
.github/ISSUE_TEMPLATE/----------.md

@@ -1,22 +0,0 @@
----
-name: 这是提 建议 的模板
-about: 看看你要新增或者改进什么功能
-title: ''
-labels: ''
-assignees: ''
-
----
-
-## 你使用的 chinesesubfinder 是什么版本,什么环境?
-
-chinesesubfinder 版本: v0.4.0
-
-环境: docker or Window or Linux or MAC
-
-## 你想要新增或者改进什么功能?
-
-你想要新增或者改进什么功能?
-
-## 这个功能有什么可以参考的资料吗?
-
- 这个功能有什么可以参考的资料吗?是否可以列举一些.

+ 0 - 103
.github/ISSUE_TEMPLATE/----bug----.md

@@ -1,103 +0,0 @@
----
-name: 这是提 Bug 的模板
-about: 请尽可能填写模板中的信息,有助于定位问题
-title: ""
-labels: ""
-assignees: ""
----
-
-## 你使用的 chinesesubfinder 是什么版本,什么环境?
-
-> chinesesubfinder 版本: vx.x.x
->
-> 环境: docker or Window or Linux or MAC
->
-> 在程序运行日志头部或者 Web UI 可以看到
-
-## 你遇到什么问题了?
-
-> 描述一下你遇到的问题
-
-## 你的问题弄重现嘛?
-
-> 能够重新,不能够重现
-
-## 你期望的结果
-
-> 描述以下你期望的结果
-
-## 给出当前程序的配置文件
-
-> /volume1/docker/chinesesubfinder/config:/config 下,ChineseSubFinderSettings.json,记得把你的用户名、密码、Emby API 敏感信息删除
->
-> 可以复制上面的配置,使用类似在线 json 格式化的工具进行一次处理,方便阅读,[JSON 在线解析及格式化验证 - JSON.cn](https://www.json.cn/#)
-
-```json
-{
-  "user_info": {
-    "username": "xx", // 这里是用户名,需要替换掉
-    "password": "xx" // 这里是密码,需要替换掉
-  },
-  "common_settings": {
-    "scan_interval": "6h",
-    "threads": 1,
-    "run_scan_at_start_up": false,
-    "movie_paths": ["X:\\电影"],
-    "series_paths": ["X:\\连续剧"]
-  },
-  "advanced_settings": {
-    "proxy_settings": {
-      "use_http_proxy": false,
-      "http_proxy_address": ""
-    },
-    "debug_mode": false,
-    "save_full_season_tmp_subtitles": true,
-    "sub_type_priority": 0,
-    "sub_name_formatter": 0,
-    "save_multi_sub": true,
-    "custom_video_exts": [],
-    "fix_time_line": false,
-    "topic": 1
-  },
-  "emby_settings": {
-    "enable": true,
-    "address_url": "http://192.168.50.xxx:xxx", // 这里替换掉
-    "api_key": "xxxxxxxxxxxxxx", // 这里替换掉
-    "max_request_video_number": 100,
-    "skip_watched": true,
-    "movie_paths_mapping": {
-      "X:\\电影": "/mnt/share1/电影"
-    },
-    "series_paths_mapping": {
-      "X:\\连续剧": "/mnt/share1/连续剧"
-    }
-  },
-  "developer_settings": {
-    "enable": false,
-    "bark_server_address": ""
-  },
-  "timeline_fixer_settings": {
-    "max_offset_time": 120,
-    "min_offset": 0.1
-  }
-}
-```
-
-## 如果是使用 Docker,请给出对应的配置信息
-
-> 比如 Docker-Compose 信息,如果是其他方式使用忽略
-
-## 给出媒体文件夹的目录结构
-
-> 首先你需要去看主页的部署教程,确认你目录结构是规范的,如果你觉得没问题,那么请除非目录结构截图
-
-> 是否看过对应的目录结构要求文档?
-
-- [电影的推荐目录结构](https://github.com/ChineseSubFinder/ChineseSubFinder/blob/docs/DesignFile/%E7%94%B5%E5%BD%B1%E5%92%8C%E8%BF%9E%E7%BB%AD%E5%89%A7%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84%E7%A4%BA%E4%BE%8B.md)
-- [连续剧目录结构要求](https://github.com/ChineseSubFinder/ChineseSubFinder/blob/docs/DesignFile/%E8%BF%9E%E7%BB%AD%E5%89%A7%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84%E8%A6%81%E6%B1%82.md)
-
-## 请给出当次问题的完整日志
-
-> 日志在程序的 Logs 目录下,如果你用的是 docker ,那么需要你映射出来。
-
-> /volume1/docker/chinesesubfinder/config:/config 下,Logs 中

+ 0 - 51
.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE_BUG.md

@@ -1,51 +0,0 @@
----
-name:
-about:
-title:
-labels: ""
-assignees: ""
----
-
-## 你使用的 chinesesubfinder 是什么版本,什么环境?
-
-> chinesesubfinder 版本: vx.x.x
->
-> 环境: docker or Window or Linux or MAC
->
-> 在程序运行日志头部或者 Web UI 可以看到
-
-## 你看过[提问前,建议先看这里的排查问题的建议和步骤](https://github.com/ChineseSubFinder/ChineseSubFinder/issues/585) 了吗?
-
-> No?那就先看看。
-
-## 你遇到什么问题了?
-
-> 描述一下你遇到的问题
-
-## 你的问题弄重现嘛?
-
-> 能够重新,不能够重现
-
-## 你期望的结果
-
-> 描述以下你期望的结果
-
-## 给出当前程序的配置文件
-
-> /volume1/docker/chinesesubfinder/config:/config 下,ChineseSubFinderSettings.json
-
-## 如果是使用 Docker,请给出对应的配置信息
-
-> 比如 Docker-Compose 信息,如果是其他方式使用忽略
-
-## 媒体库的树形目录结构
-
-> 截图或者命令输出,注意格式,太乱看不懂
-
-## 请给出当次问题的完整日志
-
-> 日志在程序的 Logs 目录下,如果你用的是 docker ,那么需要你映射出来。
-
-> 日志少还好,如果把一天的日志放上来,要看什么问题,关键词是什么,时间段是多少,不要让开发者去猜你的问题。
-
-> /volume1/docker/chinesesubfinder/config:/config 下,Logs 中

+ 0 - 24
.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE_Suggest.md

@@ -1,24 +0,0 @@
----
-name: 
-about: 
-title: 
-labels: ''
-assignees: ''
-
----
-
-## 你使用的 chinesesubfinder 是什么版本,什么环境?
-
-> chinesesubfinder 版本: vx.x.x
->
-> 程序启动后会显示版本(v0.16.x 后才有)
->
-> 环境: docker or Window or Linux or MAC
-
-## 你想要新增或者改进什么功能?
-
-你想要新增或者改进什么功能?
-
-## 这个功能有什么可以参考的资料吗?
-
- 这个功能有什么可以参考的资料吗?是否可以列举一些.

+ 93 - 0
.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,93 @@
+name: 问题反馈
+description: 请尽可能填写模板中的信息,有助于定位问题
+title: "[错误报告]: 请在此处简单描述你的问题"
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        请确认以下信息:
+        1. 请按此模板提交issues,不按模板提交的问题将直接关闭。
+        2. 如果你的问题可以直接在以往 issue 中找到,那么你的 issue 将会被直接关闭。
+        3. 提交问题务必描述清楚、附上日志,描述不清导致无法理解和分析的问题会被直接关闭。
+  - type: checkboxes
+    id: ensure
+    attributes:
+      label: 确认
+      description: 在提交 issue 之前,请确认你已经阅读并确认以下内容
+      options:
+        - label: 我的版本是最新版本,我的版本号与 [version](https://github.com/ChineseSubFinder/ChineseSubFinder/releases/latest) 相同。
+          required: true
+        - label: 我已经 [issue](https://github.com/ChineseSubFinder/ChineseSubFinder/issues) 中搜索过,确认我的问题没有被提出过。
+          required: true
+        - label: 我已经修改标题,将标题中的 描述 替换为我遇到的问题。
+          required: true
+  - type: input
+    id: version
+    attributes:
+      label: 当前程序版本
+      description: 遇到问题时程序所在的版本号
+    validations:
+      required: true
+  - type: dropdown
+    id: environment
+    attributes:
+      label: 运行环境
+      description: 您运行程序的环境
+      options:
+        - Docker
+        - Windows
+        - Linux
+        - MacOS
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: 问题描述
+      description: 请详细描述你碰到的问题
+      placeholder: "问题描述"
+    validations:
+      required: true
+  - type: dropdown
+    id: reappear
+    attributes:
+      label: 问题复现
+      description: 您的问题是否能够重现?
+      options:
+        - 是
+        - 否
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: 发生问题时系统日志
+      description: |
+        问题出现时,程序运行日志请复制到这里,日志在程序的 Logs 目录。
+      render: bash
+  - type: textarea
+    id: config
+    attributes:
+      label: 发生问题时配置文件和Docker配置信息
+      description: |
+        1. 配置文件在 `/volume1/docker/chinesesubfinder/config:/config` 下,ChineseSubFinderSettings.json,记得把你的用户名、密码、Emby API 敏感信息删除。
+           可以复制上面的配置,使用类似在线 json 格式化的工具进行一次处理,方便阅读,[JSON 在线解析及格式化验证 - JSON.cn](https://www.json.cn/#)
+        2. 如果是使用 Docker 部署,请给出对应的 docker-compose 或 docker-cli 信息,如果是其他方式使用忽略。
+      render: JSON
+  - type: textarea
+    id: dir
+    attributes:
+      label: 媒体文件夹的目录结构
+      description: |
+        1. 你需要去看主页的部署教程,确认你目录结构是规范的,如果你觉得没问题,那么请除非目录结构截图
+        2. 是否看过对应的目录结构要求文档?
+          - [电影的推荐目录结构](https://github.com/ChineseSubFinder/ChineseSubFinder/blob/docs/DesignFile/%E7%94%B5%E5%BD%B1%E5%92%8C%E8%BF%9E%E7%BB%AD%E5%89%A7%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84%E7%A4%BA%E4%BE%8B.md)
+          - [连续剧目录结构要求](https://github.com/ChineseSubFinder/ChineseSubFinder/blob/docs/DesignFile/%E8%BF%9E%E7%BB%AD%E5%89%A7%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84%E8%A6%81%E6%B1%82.md)
+      placeholder: "媒体文件夹的目录结构"
+  - type: textarea
+    id: result
+    attributes:
+      label: 你期望的结果
+      description: 你期望的结果
+      placeholder: "你期望的结果"

+ 5 - 0
.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 项目讨论
+    url: https://github.com/ChineseSubFinder/ChineseSubFinder/discussions/new/choose
+    about: discussion

+ 42 - 0
.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,42 @@
+name: 功能改进
+description: 看看你要新增或者改进什么功能
+title: "[Feature Request]: "
+labels: ["feature request"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        请说明你希望添加的功能。
+  - type: input
+    id: version
+    attributes:
+      label: 当前程序版本
+      description: 遇到问题时程序所在的版本号
+    validations:
+      required: true
+  - type: dropdown
+    id: environment
+    attributes:
+      label: 运行环境
+      description: 您运行程序的环境
+      options:
+        - Docker
+        - Windows
+        - Linux
+        - MacOS
+    validations:
+      required: true
+  - type: textarea
+    id: feature-request
+    attributes:
+      label: 功能改进
+      description: 请详细描述需要改进或者添加的功能。
+      placeholder: "功能改进"
+    validations:
+      required: true
+  - type: textarea
+    id: references
+    attributes:
+      label: 参考资料
+      description: 可以列举一些参考资料
+      placeholder: "参考资料"