From 62275b8364319f64e6711058258ee8fc911dc31a Mon Sep 17 00:00:00 2001 From: sansan <77180927+sansan0@users.noreply.github.com> Date: Fri, 14 Nov 2025 16:10:05 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BC=98=E5=8C=96=20issue=20=E6=A8=A1?= =?UTF-8?q?=E6=9D=BF=E5=92=8C=E6=9B=B4=E6=96=B0=E8=87=B4=E8=B0=A2=E5=90=8D?= =?UTF-8?q?=E5=8D=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/01-bug-report.yml | 60 +++++++++++++++- .github/ISSUE_TEMPLATE/03-config-help.yml | 84 +++++++++++++++++++++-- readme.md | 10 ++- 3 files changed, 144 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml index 0b7d6c5..f028116 100644 --- a/.github/ISSUE_TEMPLATE/01-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -10,11 +10,65 @@ body: - type: markdown attributes: value: | - ### 💝 温馨提醒 + **详细清楚的问题描述能帮助项目作者更快理解和解决你遇到的困扰**。强烈建议上传截图，图文并茂会让问题更容易被理解和定位。 - 如果这个项目对你有帮助，欢迎给项目点个 ⭐ **Star**！ + --- - 详细的问题描述能帮助项目作者更快地了解你的困扰。**强烈建议上传截图**，一图胜千言！ + ### 📋 提交问题前，请先检查以下事项 + + #### 1️⃣ **建议先查看文档** 📖 + 大部分常见问题在文档中都有详细说明，建议先查看相关章节： + - [📝 配置教程](https://github.com/sansan0/TrendRadar#-快速开始) + - [❓ 常见问题](https://github.com/sansan0/TrendRadar#问题答疑与1元点赞) + - [🐳 Docker部署](https://github.com/sansan0/TrendRadar#-docker-部署) + + #### 2️⃣ **测试推送功能的注意事项** ⚠️ + 测试消息推送时，请确保以下配置正确： + + **必须检查的配置项：** + - ✅ `report.mode` 设置为 `daily` 或 `current`（请勿使用 `incremental`，该模式仅在有新内容时才推送） + - ✅ `notification.push_window.enabled` 设置为 `false`（关闭推送时间窗口控制） + - ✅ `notification.enable_notification` 设置为 `true`（确保通知功能已启用） + + **说明：** + - 推送时间窗口控制（`push_window`）是可选功能，如果开启会限制推送时间范围 + - 测试时建议关闭此功能，避免因不在推送时间窗口而收不到消息 + + #### 3️⃣ **检查配置细节** 🔍 + 部分问题可能是配置细节导致，建议检查： + - 配置文件的缩进格式是否正确（YAML 格式要求严格，必须使用空格而非 Tab） + - Webhook 地址是否完整复制（注意不要有多余或缺失的字符） + - 环境变量是否正确设置 + - 文件路径是否正确 + + #### 4️⃣ **遇到困难时的建议** 💡 + - 如果尝试 30 分钟以上仍无进展，可以考虑换个思路 + - 建议重新从头阅读相关文档章节 + - 或尝试其他部署方式（如从 Docker 切换到 GitHub Actions） + + #### 5️⃣ **根据部署方式提供完整信息** 📦 + + **如果是 GitHub Actions 部署：** + 1. **必须提供** Actions 工作流链接（如：`https://github.com/你的用户名/TrendRadar/actions/workflows/crawler.yml`） + 2. **查看执行日志的步骤：** + - 打开你的仓库页面 + - 点击顶部的 **Actions** 标签 + - 点击左侧的 **Crawler** 工作流 + - 点击最近一次运行记录 + - 点击 **Run crawler** 查看详细日志 + - **截图完整的日志内容**（特别是错误部分） + 3. 提供 `config.yaml` 配置内容（隐藏敏感信息） + + **如果是 Docker 部署：** + 1. 提供项目目录结构截图（运行 `ls -la` 或打开文件管理器） + 2. 提供 Docker 容器日志（运行 `docker logs 容器名`） + 3. 提供容器状态（运行 `docker ps -a`） + 4. 提供 `.env` 文件内容（隐藏敏感信息） + + **如果是本地运行：** + 1. 提供完整的错误日志截图 + 2. 提供 `config.yaml` 配置内容 + 3. 提供 Python 版本（运行 `python --version`） - type: dropdown id: bug-category diff --git a/.github/ISSUE_TEMPLATE/03-config-help.yml b/.github/ISSUE_TEMPLATE/03-config-help.yml index 6a1f52c..bdaff53 100644 --- a/.github/ISSUE_TEMPLATE/03-config-help.yml +++ b/.github/ISSUE_TEMPLATE/03-config-help.yml @@ -10,13 +10,89 @@ body: - type: markdown attributes: value: | - ### 💝 温馨提醒 + 遇到设置问题时，**请尽可能详细描述你的问题**，并上传配置文件和错误信息的截图，这样能帮助更快定位和解决问题。 - 如果这个项目对你有帮助，欢迎给项目点个 ⭐ **Star**！ + 建议先查看项目说明文档，大部分常见问题都有详细说明。 - 遇到设置问题不要担心，**强烈建议上传配置文件和错误信息的截图**。 + --- - 📖 **建议先查看项目说明文档**，很多常见问题都有详细说明。 + ### 📋 配置问题自查清单（提问前建议阅读） + + #### 1️⃣ **优先查看文档** 📚 + 绝大部分配置问题在文档中都有详细说明，建议先查看相关章节： + - [🚀 快速开始](https://github.com/sansan0/TrendRadar#-快速开始) + - [📝 frequency_words.txt 配置](https://github.com/sansan0/TrendRadar#frequencywordstxt-配置教程) + - [🐳 Docker 部署指南](https://github.com/sansan0/TrendRadar#-docker-部署) + - [🤖 AI 分析配置](https://github.com/sansan0/TrendRadar#-ai-智能分析部署) + + #### 2️⃣ **测试推送的常见误区** ⚠️ + 测试消息推送时，请检查以下配置： + + **必须检查的配置项：** + - ❌ **错误**：`report.mode` 设置为 `incremental`（增量模式仅在有新内容时推送） + - ✅ **正确**：`report.mode` 设置为 `daily` 或 `current` + - ❌ **错误**：`notification.push_window.enabled` 设置为 `true`（推送时间窗口会限制推送时间） + - ✅ **正确**：`notification.push_window.enabled` 设置为 `false`（测试时建议关闭） + + **说明：** + - 推送时间窗口控制是可选功能，开启后只在指定时间范围内推送 + - 如果当前时间不在设定的窗口范围内，将不会收到推送消息 + - 测试时建议先关闭此功能 + + #### 3️⃣ **YAML 格式很严格** 📏 + 配置文件最常见的 3 个错误： + ```yaml + # ❌ 错误示例 1：缩进不对（必须用空格，不能用Tab） + notification: + enable_notification: true # ← 错误：缺少缩进 + + # ❌ 错误示例 2：冒号后面没有空格 + enable_notification:true # ← 错误：冒号后需要空格 + + # ✅ 正确示例： + notification: + enable_notification: true # ← 正确：2空格缩进 + 冒号后有空格 + ``` + + #### 4️⃣ **根据部署方式准备信息** 📦 + + **如果你是 GitHub Actions 部署：** + 1. **必须提供** Actions 工作流链接（格式：`https://github.com/你的用户名/TrendRadar/actions/workflows/crawler.yml`） + 2. **如何查看并截图执行日志：** + ``` + 步骤 1：打开你的仓库，点击顶部 "Actions" 标签 + 步骤 2：点击左侧 "Crawler" 工作流 + 步骤 3：点击最近一次运行记录（最上面的那个） + 步骤 4：点击展开 "Run crawler" 步骤 + 步骤 5：截图完整的日志内容（特别是红色错误部分） + ``` + 3. 提供 `config.yaml` 配置内容（记得隐藏 webhook 地址） + + **如果你是 Docker 部署：** + 1. 提供项目目录结构截图（运行 `ls -la` 或打开文件管理器） + 2. 提供 Docker 日志（运行 `docker logs 容器名`） + 3. 提供容器状态（运行 `docker ps -a`） + 4. 提供 `.env` 文件内容（隐藏敏感信息） + + **如果你是本地运行：** + 1. 提供完整的错误信息截图 + 2. 提供 `config.yaml` 配置内容 + 3. 提供 Python 版本（运行 `python --version`） + + #### 5️⃣ **遇到困难时的建议** 🤔 + - 如果尝试 30 分钟以上仍无进展，建议考虑换个思路 + - 可以尝试： + 1. 重新从头阅读相关文档章节 + 2. 尝试其他部署方式（如从 Docker 切换到 GitHub Actions） + 3. 对比文档示例，检查差异之处 + + #### 6️⃣ **提问时请尽量提供以下信息** 📋 + 为了更快地帮你定位问题，建议提供： + - ✅ 配置文件内容（请隐藏 webhook 等敏感信息） + - ✅ 完整的错误日志截图 + - ✅ 部署方式（本地运行/Docker/GitHub Actions） + - ✅ 已经尝试过的解决方法 + - ✅ 具体的问题现象（请避免只说"不生效"或"没反应"，尽量描述具体表现） - type: dropdown id: config-type diff --git a/readme.md b/readme.md index 3f6c590..8cab1e7 100644 --- a/readme.md +++ b/readme.md @@ -39,6 +39,7 @@ | [🎯 核心功能](#-核心功能) | [🚀 快速开始](#-快速开始) | [🐳 Docker部署](#-docker-部署) | [🤖 AI分析专区](#-ai-智能分析部署) | |:---:|:---:|:---:|:---:| | [📝 更新日志](#-更新日志) | [🔌 MCP客户端](#-mcp-客户端) | [❓ 答疑与常见问题](#问题答疑与1元点赞) | [⭐ 项目相关](#项目相关) | +| [🔧 自定义监控平台](#自定义监控平台) | [📝 frequency_words.txt 配置](#frequencywordstxt-配置教程) | | | @@ -47,7 +48,7 @@ - 感谢**关注[公众号](#问题答疑与1元点赞)** 的读者们，你们的留言、点赞、分享和推荐等积极互动让内容更有温度😎。
-👉 点击查看致谢名单 (当前 🔥59🔥 位) +👉 点击查看致谢名单 (当前 🔥62🔥 位) ### 数据支持 @@ -67,6 +68,9 @@ | 点赞人 | 金额 | 日期 | 备注 | | :-------------------------: | :----: | :----: | :-----------------------: | +| **柯 | 1 | 2025.11.14 | | +| *云 | 88 | 2025.11.13 | 好项目，感谢开源 | +| *W | 6 | 2025.11.13 | | | *凯 | 1 | 2025.11.13 | | | 对*. | 1 | 2025.11.13 | Thanks for your TrendRadar | | s*y | 1 | 2025.11.13 | | @@ -146,7 +150,7 @@ 默认监控 11 个主流平台，也可自行增加额外的平台 -
+
👉 自定义监控平台
@@ -202,7 +206,7 @@ platforms: > 也可以不做筛选，完整的推送所有热点，具体见【历史更新】中的 v2.0.1 -
+
👉 frequency_words.txt 配置教程