update: ISSUE_TEMPLATE

oddfar · Feb 17, 2024 · ab339b1 · ab339b1
1 parent e69dfaf
commit ab339b1
Show file tree

Hide file tree

Showing 4 changed files with 158 additions and 66 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,124 @@
+name: 报告bug
+description: 创建一个报告，请详细描述，来帮助我们改进
+title: '[bug]: '
+labels: [ "bug" ]
+
+body:
+  # User's README and agreement
+  - type: markdown
+    attributes:
+      value: |
+        ## 感谢您愿意填写错误回报！
+        ## 以下是一些注意事项，请务必阅读让我们能够更容易处理
+
+        ### ❗ | 查看[文档](https://oddfar.github.io/campus-doc/campus-imaotai)里是否有解决方案 
+        ### ❗ | 确定没有相同问题的 ISSUE 已被提出. 
+        ### ❗ | 如果是部署问题，在[讨论区](https://github.com/oddfar/campus-imaotai/discussions/categories/show-and-tell)里搜索是否存在相似的部署方案
+
+
+        ## 如果您不知道如何有效、精准地表述，我们建议您先阅读《提问的智慧》
+        链接: [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)
+        ---
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: 请确保您已阅读以上注意事项，并勾选下方的确认框。
+      options:
+        - label: "我已确认我已升级到最新版本（最新代码）测试过，问题依旧存在。"
+          required: true
+        - label: "我已经在 [Issue Tracker](https://github.com/oddfar/campus-imaotai/issues) 中找过我要提出的问题，没有找到相同问题的ISSUE。"
+          required: true
+        - label: "我理解并认可上述内容，并理解项目维护者精力有限，不遵循规则的 issue 可能会被无视或直接关闭"
+          required: true
+
+  # User's data
+  - type: markdown
+    attributes:
+      value: |
+        ## 环境信息
+        请根据实际使用环境修改以下信息。
+
+  # Env |  Version
+  - type: input
+    id: env-version
+    attributes:
+      label: 版本信息
+      options:
+        - label: campus框架版本
+        - label: 本项目 campus-imaotai 版本
+          required: true                                                                                                                                                                                                                                                                                                                                                                                                                                                       
+
+
+  # Env | VM Version
+  - type: dropdown
+    id: env-vm-ver
+    attributes:
+      label: 运行环境
+      description: 选择运行 campus-imaotai 的系统版本
+      options:
+        - Windows (64)
+        - Windows (32/x84)
+        - MacOS
+        - Linux
+        - Ubuntu
+        - CentOS
+        - ArchLinux
+        - UNIX (Android)
+        - 其它（请在下方说明）
+    validations:
+      required: true
+
+  # Env | VM Arch
+  - type: dropdown
+    id: env-vm-arch
+    attributes:
+      label: 运行架构
+      description: (可选) 选择运行 campus-imaotai 的系统架构
+      options:
+        - AMD64
+        - x86
+        - ARM [32] (别名：AArch32 / ARMv7）
+        - ARM [64] (别名：AArch64 / ARMv8）
+        - 其它
+
+  # Input | Reproduce
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: 问题描述
+      description: |
+        1. 使用的什么功能，遇到什么问题
+        2. 返回的实际结果是什么
+    validations:
+      required: true
+
+  # Input | Expected result
+  - type: textarea
+    id: expected
+    attributes:
+      label: 期望的结果是什么？
+    validations:
+      required: true
+
+  # Optional | Reproduce code
+  - type: textarea
+    id: reproduce-code
+    attributes:
+      label: 简单的复现代码/链接（可选）
+      render: java
+
+  # Optional | Logging
+  - type: textarea
+    id: logging
+    attributes:
+      label: 日志记录（可选）
+      description: |
+        截图或者日志记录都可以，比如 Docker 容器的日志。
+        Docker中查看容器的日志，可以使用 `docker logs container_id` 命令。
+         `container_id` 为目标容器的ID或名称
+
+  # Optional | Extra description
+  - type: textarea
+    id: extra-desc
+    attributes:
+      label: 补充说明（可选）
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,21 @@
+---
+name: ⭐ 功能请求 —— Feature Request
+about: 使用简练详细的语言描述希望加入的新功能
+title: '[Feature] 请填写标题'
+labels: enhancement
+assignees: ''
+
+---
+
+## 例行检查
+
++ [ ] 我已确认目前没有类似 issue
++ [ ] 我已确认我已升级到最新版本
++ [ ] 我理解并愿意跟进此 issue，协助测试和提供反馈
++ [ ] 我理解并认可上述内容，并理解项目维护者精力有限，不遵循规则的 issue 可能会被无视或直接关闭
+
+## 功能请求
+<!--写一个清晰简洁的描述来表明功能或问题是什么。-->
+
+## 解决方案和应用场景
+<!-- 新功能的解决方案和应用场景。-->
diff --git a/README.md b/README.md
@@ -15,38 +15,24 @@
 
 i茅台app，每日自动预约茅台
 
-- [x] 平台注册账号(可用i茅台)
+- [x] 平台注册账号
 - [x] 添加多个用户
 - [x] 自动预约
 - [x] 类型选择（本市出货量最大的门店，或位置附近门店）
 - [x] 自动旅行
 - [x] 首次旅行分享
 - [x] 获取申购耐力值
 - [x] 自定义时间/随机时间预约或旅行
-- [x] 结果消息推送
+- [x] 申购结果消息推送
 
 此项目使用 **Campus** 进行编写：<https://github.com/oddfar/campus>
 
-## 使用教程
+## 文档
 
-- 文档教程
+- 文档：https://oddfar.github.io/campus-doc/campus-imaotai
 
-  https://oddfar.github.io/campus-doc/campus-imaotai
-
-- 视频教程
+- 视频：https://www.bilibili.com/video/BV1dj411H7oT
 
-  https://www.bilibili.com/video/BV1dj411H7oT
-
-有问题请查看文档，查找 [issues](https://github.com/oddfar/campus-imaotai/issues) 上是否有相同问题，若没有则提交 [issues](https://github.com/oddfar/campus-imaotai/issues)  ，附带详细的错误原因
-
-不会Docker部署的，可使用客户端：<https://github.com/lisongkun/hygge-imaotai>
-
-
-## 友情链接
-
-- 葫芦娃项目
-
-  yize8888-maotai: https://github.com/yize8888/maotai
 
 ## 演示图
 
@@ -76,7 +62,15 @@ i茅台app，每日自动预约茅台
 
 ![Stargazers over time](https://starchart.cc/oddfar/campus-imaotai.svg)
 
+## 友情链接
+
+- 本项目其他版
+
+  C#：<https://github.com/lisongkun/hygge-imaotai>
+
+- 葫芦娃项目
 
+  yize8888-maotai：https://github.com/yize8888/maotai
 
 ## 声明