浏览代码

chore: 调整 issues 模板和readme

sansan 8 月之前
父节点
当前提交
33f854c53a
共有 4 个文件被更改,包括 226 次插入179 次删除
  1. 98 67
      .github/ISSUE_TEMPLATE/01-bug-report.yml
  2. 51 51
      .github/ISSUE_TEMPLATE/02-feature-request.yml
  3. 71 58
      .github/ISSUE_TEMPLATE/03-config-help.yml
  4. 6 3
      readme.md

+ 98 - 67
.github/ISSUE_TEMPLATE/01-bug-report.yml

@@ -1,8 +1,8 @@
 # yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
 
-name: 🐛 Bug 报告
-description: 报告程序错误或异常行为
-title: "[Bug] "
+name: 🐛 遇到问题了
+description: 程序运行不正常或出现错误
+title: "[问题] "
 labels: ["bug"]
 assignees:
   - sansan0
@@ -10,114 +10,145 @@ body:
   - type: markdown
     attributes:
       value: |
-        感谢你的反馈!详细的 Bug 报告有助于快速定位和修复问题。
+        ### 💝 温馨提醒
+
+        如果这个项目对你有帮助,欢迎给项目点个 ⭐ **Star**!
+
+        详细的问题描述能帮助项目作者更快地了解你的困扰。**强烈建议上传截图**,一图胜千言!
 
   - type: dropdown
     id: bug-category
     attributes:
-      label: 🏷️ 问题类型
+      label: 🏷️ 遇到了什么问题
       options:
-        - 数据抓取失败
-        - 频率词匹配异常
-        - 通知发送失败
-        - 配置解析错误
-        - Docker 部署问题
-        - 报告生成错误
-        - 性能问题
-        - 其他
+        - 数据获取问题(获取不到新闻、请求失败等)
+        - 关键词筛选问题(关键词不生效、匹配异常等)
+        - 通知推送问题(收不到消息、推送失败等)
+        - 配置设置问题(配置文件错误、参数不生效等)
+        - 部署运行问题(Docker、GitHub Actions等)
+        - 性能问题(运行慢、卡顿等)
+        - 其他问题
     validations:
       required: true
 
-  - type: textarea
-    id: bug-description
+  - type: dropdown
+    id: environment
     attributes:
-      label: 📝 问题描述
-      description: 详细描述遇到的问题
-      placeholder: |
-        请清楚地描述:
-        - 发生了什么问题
-        - 问题的具体表现
-        - 影响范围
+      label: 🖥️ 使用环境
+      options:
+        - 本地运行(直接在电脑上运行)
+        - Docker 容器运行
+        - GitHub Actions 自动运行
+        - 其他方式
     validations:
       required: true
 
   - type: textarea
-    id: reproduction-steps
+    id: bug-description
     attributes:
-      label: 🔄 复现步骤
-      description: 如何重现这个问题?
+      label: 📝 详细描述问题
+      description: 请详细说明遇到的问题(建议配合截图说明)
       placeholder: |
-        1. 运行命令:python main.py
-        2. 配置设置:...
-        3. 观察到的现象:...
-    validations:
-      required: true
+        请清楚地描述:
+        - 具体发生了什么问题
+        - 问题出现时的情况
+        - 这个问题影响了什么功能
 
-  - type: textarea
-    id: expected-behavior
-    attributes:
-      label: ✅ 期望行为
-      description: 正常情况下应该发生什么?
-      placeholder: 描述期望的正常行为...
+        💡 提示:上传问题截图能提供更多信息。
     validations:
       required: true
 
   - type: dropdown
-    id: environment
+    id: system-info
     attributes:
-      label: 🖥️ 运行环境
+      label: 💻 系统信息
+      description: 你的电脑系统
       options:
-        - 本地 Python 环境
-        - Docker 容器
-        - GitHub Actions
-        - 其他
+        - Windows 10
+        - Windows 11
+        - macOS
+        - Ubuntu/Linux
+        - 其他系统
+        - 不确定
     validations:
-      required: true
+      required: false
 
-  - type: input
-    id: python-version
+  - type: textarea
+    id: reproduction-steps
     attributes:
-      label: 🐍 Python 版本
-      description: 使用的 Python 版本
-      placeholder: 如:3.10.0
+      label: 🔄 怎么重现这个问题
+      description: 如何让这个问题重新出现?(可选,但建议填写)
+      placeholder: |
+        请按步骤描述(建议每个步骤都配截图):
+        1. 我点击了...
+        2. 然后设置了...
+        3. 接着出现了...
+
+        💡 操作过程的截图特别有用!
     validations:
-      required: true
+      required: false
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: ✅ 期望的正常情况
+      description: 正常情况下应该是什么样的?(可选)
+      placeholder: |
+        描述你期望看到的正常结果...
+        如果有参考图片就更好了!
+    validations:
+      required: false
 
   - type: textarea
     id: error-logs
     attributes:
-      label: 📋 错误日志
-      description: 相关的错误信息或日志
+      label: 📋 错误信息
+      description: 程序显示的错误信息或日志(如果有的话)
       placeholder: |
-        请粘贴完整的错误堆栈信息或相关日志:
-        
+        如果程序显示了错误信息,请完整复制到这里
+
         ```
-        错误信息...
+        错误信息内容...
         ```
+
     validations:
-      required: true
+      required: false
 
   - type: textarea
     id: config-info
     attributes:
-      label: ⚙️ 配置信息
-      description: 相关的配置设置(请隐藏敏感信息
+      label: ⚙️ 相关配置
+      description: 与问题相关的配置内容(请隐藏敏感信息如 webhook 地址
       placeholder: |
-        相关的配置片段(请移除敏感信息如 webhook URL):
-        
+        相关的配置内容(记得隐藏敏感信息):
+
         ```yaml
-        crawler:
-          request_interval: 1000
-          enable_crawler: true
+        notification:
+          enable_notification: true
+          webhooks:
+            feishu_url: "***隐藏***"
         ```
 
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: 📷 截图补充
+      description: 上传相关截图(强烈推荐!)
+      placeholder: |
+        请拖拽截图到这里,建议包含:
+        - 错误界面截图
+        - 配置设置截图
+        - 操作步骤截图
+
+        💡 截图是最直观的问题说明方式!
+
   - type: textarea
     id: additional-context
     attributes:
-      label: 📎 其他信息
+      label: 📎 其他补充信息
       description: 其他可能有用的信息
       placeholder: |
-        - 网络环境
-        - 使用的平台配置
-        - 频率词配置
-        - 其他相关信息
+        - 网络环境特殊情况
+        - 之前是否正常工作过
+        - 最近有没有改动什么设
+        - 其他你觉得可能相关信息

+ 51 - 51
.github/ISSUE_TEMPLATE/02-feature-request.yml

@@ -1,8 +1,8 @@
 # yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
 
-name: 💡 功能建议
-description: 提出新功能想法或改进建议
-title: "[功能] "
+name: 💡 我有个想法
+description: 建议新功能或改进现有功能
+title: "[建议] "
 labels: ["enhancement"]
 assignees:
   - sansan0
@@ -10,89 +10,89 @@ body:
   - type: markdown
     attributes:
       value: |
-        感谢你的创意!好的想法让这个项目变得更加实用。
+        ### 💝 温馨提醒
+
+        感谢你的创意想法!如果这个项目对你有帮助,欢迎给项目点个 ⭐ **Star**!
+
+        好的建议让项目变得更加实用。**欢迎用截图或示例**来展示你的想法!
 
   - type: dropdown
     id: feature-category
     attributes:
-      label: 🏷️ 功能类别
+      label: 🏷️ 建议类别
       options:
-        - 数据抓取增强
-        - 分析算法改进
-        - 通知方式扩展
-        - 配置管理优化
-        - 部署便利性
-        - 数据可视化
-        - 监控与告警
-        - 其他
+        - 数据源相关(新增平台、改进抓取等)
+        - 分析功能相关(算法改进、筛选优化等)
+        - 通知方式相关(新增通知渠道、消息格式等)
+        - 配置管理相关(设置优化、界面改进等)
+        - 部署运维相关(安装简化、监控告警等)
+        - 数据展示相关(报告格式、图表可视化等)
+        - 性能优化相关
+        - 用户体验改进
+        - 其他想法
     validations:
       required: true
 
   - type: textarea
     id: feature-description
     attributes:
-      label: 💭 功能描述
-      description: 详细描述你希望添加的功能
+      label: 💭 详细描述你的想法
+      description: 详细描述你希望添加的功能
       placeholder: |
         请详细描述:
-        - 功能的具体内容
-        - 如何使用这个功能
-        - 期望的效果
+        - 你希望增加什么功能
+        - 这个功能应该怎么使用
+        - 使用后能达到什么效果
+
+        💡 提示:如果有类似功能的截图作为参考就更好了!
     validations:
       required: true
 
   - type: textarea
     id: use-case
     attributes:
-      label: 🎯 使用场景
-      description: 这个功能会在什么情况下使用?
+      label: 🎯 什么时候会用到这个功能
+      description: 这个功能在什么场景下使用?
       placeholder: |
         例如:
-        - 当用户需要...的时候
-        - 在...场景下会很有帮助
+        - 当需要...的时候
+        - 在...情况下会很方便
         - 可以解决...问题
+        - 能够帮助...用户
     validations:
       required: true
 
   - type: textarea
-    id: current-workaround
+    id: implementation-ideas
     attributes:
-      label: 🔄 现有解决方案
-      description: 目前是如何处理这个需求的?
+      label: 🛠️ 实现想法(可选)
+      description: 如果你有实现思路,欢迎分享
       placeholder: |
-        - 目前的替代方案
-        - 现有方案的不足
-        - 为什么需要新功能
-
-  - type: dropdown
-    id: feature-priority
-    attributes:
-      label: ⭐ 优先级
-      description: 你认为这个功能的重要程度
-      options:
-        - 高 - 非常重要,强烈建议
-        - 中 - 会很有用,建议考虑
-        - 低 - 锦上添花,有时间可做
-    validations:
-      required: true
+        - 功能界面应该怎么设计
+        - 配置应该怎么设置
+        - 参考哪些类似的工具或网站
+        - 其他实现建议
 
   - type: textarea
-    id: implementation-ideas
+    id: mockups-examples
     attributes:
-      label: 🛠️ 实现想法(可选
-      description: 如果你有实现思路,欢迎分享
+      label: 📷 功能示意图(推荐)
+      description: 上传功能示意图、参考截图或手绘草图
       placeholder: |
-        - 技术实现方案
-        - 配置设计建议
-        - 用户界面设计
-        - 参考项目或工具
+        请上传:
+        - 功能界面的设计图(手绘也可以)
+        - 类似功能的参考截图
+        - 使用流程的示意图
+
+        💡 可视化的说明最容易理解!
 
   - type: textarea
     id: additional-context
     attributes:
-      label: 📎 其他信息
+      label: 📎 其他补充说明
       description: 其他想要补充的内容
       placeholder: |
-        - 相关截图或示例
-        - 类似功能的参考
-        - 其他相关想法
+        - 相关的参考资料链接
+        - 类似功能的其他工具
+        - 更多使用场景说明
+        - 其他相关想法

+ 71 - 58
.github/ISSUE_TEMPLATE/03-config-help.yml

@@ -1,8 +1,8 @@
 # yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json
 
-name: ⚙️ 配置帮助
-description: 配置相关的问题或优化建议
-title: "[置] "
+name: ⚙️ 设置遇到困难
+description: 配置相关的问题或需要帮助
+title: "[置] "
 labels: ["配置", "帮助"]
 assignees:
   - sansan0
@@ -10,99 +10,112 @@ body:
   - type: markdown
     attributes:
       value: |
-        遇到配置问题?我们来帮你解决!
+        ### 💝 温馨提醒
 
-        📖 **建议先查看 README 文档和配置文件注释**
+        如果这个项目对你有帮助,欢迎给项目点个 ⭐ **Star**!
+
+        遇到设置问题不要担心,**强烈建议上传配置文件和错误信息的截图**。
+
+        📖 **建议先查看项目说明文档**,很多常见问题都有详细说明。
 
   - type: dropdown
     id: config-type
     attributes:
-      label: 🏷️ 配置类型
+      label: 🏷️ 配置问题类别
       options:
-        - 基础配置问题
-        - Webhook 配置
-        - Docker 部署配置
-        - 频率词配置
-        - 平台配置
-        - 定时任务配置
-        - 其他
+        - 基础配置问题(config.yaml 设置)
+        - 通知配置问题(webhook、消息推送等)
+        - 部署配置问题(Docker、GitHub Actions等)
+        - 关键词配置问题(frequency_words.txt 设置)
+        - 环境配置问题(Python、依赖包等)
+        - 其他配置问题
     validations:
       required: true
 
   - type: dropdown
-    id: problem-type
+    id: environment
     attributes:
-      label: 🔍 问题类型
+      label: 🖥️ 使用环境
       options:
-        - 配置不生效
-        - 不知道如何配置
-        - 配置优化建议
-        - 配置文档改进
-        - 配置验证问题
+        - 本地运行(直接在电脑上运行)
+        - Docker 容器运行
+        - GitHub Actions 自动运行
+        - 其他方式
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: 📝 详细描述问题
+      description: 请详细描述你遇到的设置问题
+      placeholder: |
+        请详细描述:
+        - 遇到的具体问题是什么
+        - 你希望达到什么效果
+        - 已经尝试了哪些方法
+        - 参考了哪些文档或教程
+
+        💡 问题截图能提供更多信息!
     validations:
       required: true
 
   - type: textarea
     id: config-content
     attributes:
-      label: 📄 相关配置
-      description: 请提供相关的配置内容(请隐藏敏感信息)
+      label: 📄 配置内容
+      description: 请提供相关的配置内容(记得隐藏敏感信息如 webhook 地址
       placeholder: |
-        请贴出相关的配置片段(记得隐藏敏感信息):
-        
+        请贴出相关的配置内容(记得隐藏 webhook 地址等敏感信息):
+
         ```yaml
         notification:
           enable_notification: true
           webhooks:
-            feishu_url: "***"
+            feishu_url: "***隐藏***"
+            dingtalk_url: "***隐藏***"
         ```
-    validations:
-      required: true
 
-  - type: textarea
-    id: problem-description
-    attributes:
-      label: 📝 问题描述
-      description: 详细描述遇到的配置问题
-      placeholder: |
-        请详细描述:
-        - 遇到的具体问题
-        - 期望的效果
-        - 已经尝试的方法
+        💡 配置文件截图也很有用!
     validations:
-      required: true
+      required: false
 
   - type: textarea
     id: error-messages
     attributes:
-      label: ❌ 错误信息(如果有)
-      description: 相关的错误信息或日志
+      label: ❌ 错误信息(如果有的话)
+      description: 如果程序显示了错误信息,请贴出来
       placeholder: |
-        如果有错误信息,请贴出来
-        
+        如果有错误信息,请完整复制到这里
+
         ```
-        错误信息...
+        错误信息内容...
         ```
 
-  - type: dropdown
-    id: environment
+        💡 错误信息的截图也很重要!
+
+  - type: textarea
+    id: screenshots
     attributes:
-      label: 🖥️ 运行环境
-      options:
-        - 本地 Python 环境
-        - Docker 容器
-        - GitHub Actions
-        - 其他
-    validations:
-      required: true
+      label: 📷 相关截图(强烈推荐)
+      description: 上传配置界面、错误信息等截图
+      placeholder: |
+        请上传相关截图,特别是:
+        - 配置文件内容截图
+        - 错误信息截图
+        - 操作界面截图
+        - 期望效果的参考图
+
+        💡 截图是最直观的问题展示方式!
 
   - type: textarea
     id: additional-info
     attributes:
-      label: 📎 其他信息
+      label: 📎 其他补充信息
       description: 其他可能有用的信息
       placeholder: |
-        - 操作系统版本
-        - 网络环境
-        - 使用场景
-        - 其他相关信息
+        - 操作系统版本(如 Windows 11、macOS)
+        - Python 版本信息
+        - 网络环境特殊情况
+        - 具体使用场景说明
+        - 其他你觉得相关的信息

+ 6 - 3
readme.md

@@ -4,6 +4,8 @@
 
 🚀 最快<strong>30秒</strong>部署的热点助手 —— 告别无效刷屏,只看真正关心的新闻资讯
 
+<a href="https://trendshift.io/repositories/14726" target="_blank"><img src="https://trendshift.io/api/badge/repositories/14726" alt="sansan0%2FTrendRadar | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+
 [![GitHub Stars](https://img.shields.io/github/stars/sansan0/TrendRadar?style=flat-square&logo=github&color=yellow)](https://github.com/sansan0/TrendRadar/stargazers)
 [![GitHub Forks](https://img.shields.io/github/forks/sansan0/TrendRadar?style=flat-square&logo=github&color=blue)](https://github.com/sansan0/TrendRadar/network/members)
 [![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg?style=flat-square)](LICENSE)
@@ -20,12 +22,12 @@
 </div>
 
 
-> 本项目以轻量,易部署为目标,主要处理 issues
+> 本项目以轻量,易部署为目标
 >
-> 遇到问题提 issues,或【硅基茶水间】公众号留言
+> 遇到问题提 issues,或【硅基茶水间】公众号相关文章下留言
 
 <details>
-<summary>👉 点击查看<strong>致谢名单</strong> (当前 <strong>🔥19🔥</strong> 位)</summary>
+<summary>👉 点击查看<strong>致谢名单</strong> (当前 <strong>🔥20🔥</strong> 位)</summary>
 
 ### 数据支持
 
@@ -45,6 +47,7 @@
 
 |           点赞人            |  金额  |  日期  |             备注             |
 | :-------------------------: | :----: | :----: | :-----------------------: |
+|           z*u            |  2  | 2025.9.19  |           |
 |           **昊            |  5  | 2025.9.17  |           |
 |           *号            |  1  | 2025.9.15  |           |
 |           T*T            |  2  | 2025.9.15  |  点赞         |