From 11e2d4d958aec81958dca6e82a999a56b9403c00 Mon Sep 17 00:00:00 2001 From: Tony Date: Wed, 1 Dec 2021 18:08:13 -1000 Subject: [PATCH] chore(docs): switch to issue forms (#8624) --- .github/ISSUE_TEMPLATE/bug_report_en.md | 32 ------- .github/ISSUE_TEMPLATE/bug_report_en.yml | 86 ++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report_zh.md | 47 ---------- .github/ISSUE_TEMPLATE/bug_report_zh.yml | 88 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request_en.md | 15 ---- .github/ISSUE_TEMPLATE/feature_request_en.yml | 41 +++++++++ .github/ISSUE_TEMPLATE/feature_request_zh.md | 15 ---- .github/ISSUE_TEMPLATE/feature_request_zh.yml | 41 +++++++++ .github/ISSUE_TEMPLATE/rss_request_en.md | 19 ---- .github/ISSUE_TEMPLATE/rss_request_en.yml | 82 +++++++++++++++++ .github/ISSUE_TEMPLATE/rss_request_zh.md | 19 ---- .github/ISSUE_TEMPLATE/rss_request_zh.yml | 83 +++++++++++++++++ .prettierignore | 1 - 13 files changed, 421 insertions(+), 148 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report_en.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report_en.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report_zh.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report_zh.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request_en.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request_en.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request_zh.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request_zh.yml delete mode 100644 .github/ISSUE_TEMPLATE/rss_request_en.md create mode 100644 .github/ISSUE_TEMPLATE/rss_request_en.yml delete mode 100644 .github/ISSUE_TEMPLATE/rss_request_zh.md create mode 100644 .github/ISSUE_TEMPLATE/rss_request_zh.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report_en.md b/.github/ISSUE_TEMPLATE/bug_report_en.md deleted file mode 100644 index 5c1ca4e781e9e8..00000000000000 --- a/.github/ISSUE_TEMPLATE/bug_report_en.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: 🐛 Bug Report -about: Submit discovered bugs ---- - - - -- The involved route, with all required and optional parameters - -- What is expected - -- What is actually happening - -- Self-deployment information - - - -| Env | Value | -| ------------------ | ------------- | -| OS | | -| Node version | | -| if Docker, version | | - -- Additional info (logs errors etc) diff --git a/.github/ISSUE_TEMPLATE/bug_report_en.yml b/.github/ISSUE_TEMPLATE/bug_report_en.yml new file mode 100644 index 00000000000000..abaea019a5b9f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_en.yml @@ -0,0 +1,86 @@ +name: 🐛 Bug Report +description: Submit discovered bugs +labels: ['RSS bug'] + +body: + - type: markdown + attributes: + value: | + Please ensure you have read [documentation](https://docs.rsshub.app/en), and provide all the information required by this template, otherwise the issue will be closed immediately. + Due to the anti-crawling policy implemented by certain websites, some RSS routes provided by the demo will return status code 403. This is not an issue caused by RSSHub and please do not report it. + + - type: input + id: routes + attributes: + label: Routes + description: The involved route, without any parameters + placeholder: /rsshub/routes + validations: + required: true + + - type: input + id: fullroutes + attributes: + label: Full routes + description: The involved route, with all required and optional parameters + placeholder: /rsshub/routes + validations: + required: true + + - type: input + id: docs-link + attributes: + label: Related documentation + description: Link to related documentation + placeholder: https://docs.rsshub.app/... + validations: + required: true + + - type: textarea + id: what-expected + attributes: + label: What is expected? + validations: + required: true + + - type: textarea + id: actual-happened + attributes: + label: What is actually happening? + validations: + required: true + + - type: dropdown + id: deployment + attributes: + label: Deployment information + multiple: false + options: + - RSSHub demo (https://rsshub.app) + - Self-hosted + validations: + required: true + + - type: input + id: deploy-info + attributes: + label: Deployment information (for self-hosted) + description: Please provide your OS, node version and docker version(if applicable) + placeholder: 'OS: Linux, Node: v10.15.3, Docker: v19.03.13' + + - type: textarea + id: logs + attributes: + label: Additional info + description: logs, errors, etc. + render: shell + validations: + required: true + + - type: checkboxes + id: terms + attributes: + label: This is not a duplicated issue + options: + - label: I have searched [existing issues](https://github.com/DIYgod/RSSHub/issues) to ensure this bug has not already been reported + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report_zh.md b/.github/ISSUE_TEMPLATE/bug_report_zh.md deleted file mode 100644 index d20baa3a49db8f..00000000000000 --- a/.github/ISSUE_TEMPLATE/bug_report_zh.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: 🐛 Bug 报告 -about: 早起的小可爱有虫抓 ---- - - - -#### 路由地址（不包含参数） - -```routes -``` - -#### 完整路由地址，包含所有必选与可选参数 - -```fullroutes -``` - -#### 相关文档地址 - -- https://docs.rsshub.app/... - -#### 预期是什么 - -#### 实际发生了什么 - -#### 部署相关信息 - - - -| Env | Value | -| ------------------ | ------------- | -| OS | | -| Node version | | -| if Docker, version | | - -- 额外信息（日志、报错等） diff --git a/.github/ISSUE_TEMPLATE/bug_report_zh.yml b/.github/ISSUE_TEMPLATE/bug_report_zh.yml new file mode 100644 index 00000000000000..9840c5d33fd014 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_zh.yml @@ -0,0 +1,88 @@ +name: 🐛 Bug 报告 +description: 早起的小可爱有虫抓 +labels: ['RSS bug'] + +body: + - type: markdown + attributes: + value: | + 请确保已阅读 [文档](https://docs.rsshub.app) 内相关部分，并按照模版提供信息，否则 issue 将被立即关闭。 + 由于部分源网站反爬缘故，演示地址一些 RSS 会返回 status code 403，该问题不是 RSSHub 所致，请勿提交 issue。 + + - type: input + id: routes + attributes: + label: 路由地址 + description: 不包含参数 + placeholder: /rsshub/routes + validations: + required: true + + - type: input + id: fullroutes + attributes: + label: 完整路由地址 + description: 包含所有必选与可选参数 + placeholder: /rsshub/routes + validations: + required: true + + - type: input + id: docs-link + attributes: + label: 相关文档 + description: 相关文档地址 + placeholder: https://docs.rsshub.app/... + validations: + required: true + + - type: textarea + id: what-expected + attributes: + label: 预期是什么？ + validations: + required: true + + - type: textarea + id: actual-happened + attributes: + label: 实际发生了什么？ + validations: + required: true + + - type: dropdown + id: deployment + attributes: + label: 部署 + multiple: false + options: + - RSSHub 演示 (https://rsshub.app) + - 自建 + validations: + required: true + + - type: input + id: deploy-info + attributes: + label: 部署相关信息 + description: | + 请提供您的操作系统、node 版本和（如果适用） docker 版本。 + 请确保您部署的是[主线 master 分支](https://github.com/DIYgod/RSSHub/tree/master)最新版 RSSHub。 + placeholder: 'OS: Linux, Node: v10.15.3, Docker: v19.03.13' + + - type: textarea + id: logs + attributes: + label: 额外信息 + description: 日志、报错等 + render: shell + validations: + required: true + + - type: checkboxes + id: terms + attributes: + label: 这不是重复的 issue + options: + - label: 我已经搜索了[现有 issue](https://github.com/DIYgod/RSSHub/issues)，以确保该错误尚未被报告。 + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request_en.md b/.github/ISSUE_TEMPLATE/feature_request_en.md deleted file mode 100644 index 424b8ffc6dc2c8..00000000000000 --- a/.github/ISSUE_TEMPLATE/feature_request_en.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: 🍭 Feature Request -about: Submit a new feature request ---- - - - -### What feature is it? - -### What problem does this feature solve? - -### Additional description diff --git a/.github/ISSUE_TEMPLATE/feature_request_en.yml b/.github/ISSUE_TEMPLATE/feature_request_en.yml new file mode 100644 index 00000000000000..72f9cfa5c0ae8a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request_en.yml @@ -0,0 +1,41 @@ +name: 🍭 Feature Request +description: Submit a new feature request +labels: ['RSS enhancement'] + +body: + + - type: markdown + attributes: + value: | + Please ensure the feature requested is not listed in [documentation](https://docs.rsshub.app/en) or [issue](https://github.com/DIYgod/RSSHub/issues), and provide all the information required by this template. + Otherwise the issue will be closed immediately. + + - type: textarea + id: feature + attributes: + label: What feature is it? + placeholder: Please describe the feature you want to see. + validations: + required: true + + - type: textarea + id: problem + attributes: + label: What problem does this feature solve? + placeholder: Please describe the problem this feature solves. + validations: + required: true + + - type: textarea + id: description + attributes: + label: Additional description + placeholder: Any additional description. + + - type: checkboxes + id: terms + attributes: + label: This is not a duplicated feature request + options: + - label: I have searched [existing issues](https://github.com/DIYgod/RSSHub/issues) to ensure this feature has not already been requested + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request_zh.md b/.github/ISSUE_TEMPLATE/feature_request_zh.md deleted file mode 100644 index 4d383601813156..00000000000000 --- a/.github/ISSUE_TEMPLATE/feature_request_zh.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: 🍭 功能需求 -about: 提交新的功能需求 ---- - - - -### 这是一个什么样的功能？ - -### 这个功能可以解决什么问题？ - -### 额外描述 diff --git a/.github/ISSUE_TEMPLATE/feature_request_zh.yml b/.github/ISSUE_TEMPLATE/feature_request_zh.yml new file mode 100644 index 00000000000000..bd4ae44e5bcd7e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request_zh.yml @@ -0,0 +1,41 @@ +name: 🍭 功能需求 +description: 提交新的功能需求 +labels: ['RSS enhancement'] + +body: + + - type: markdown + attributes: + value: | + 请确保 [文档](https://docs.rsshub.app) 和 [issue](https://github.com/DIYgod/RSSHub/issues) 中没有相关内容，并按照模版提供信息， + 否则 issue 将被立即关闭。 + + - type: textarea + id: feature + attributes: + label: 这是一个什么样的功能？ + placeholder: 请描述你想看到的功能。 + validations: + required: true + + - type: textarea + id: problem + attributes: + label: 这个功能可以解决什么问题？ + placeholder: 请描述该功能解决的问题。 + validations: + required: true + + - type: textarea + id: description + attributes: + label: 额外描述 + placeholder: 任何补充说明。 + + - type: checkboxes + id: terms + attributes: + label: 这不是重复的功能请求 + options: + - label: 我已经搜索了[现有 issue](https://github.com/DIYgod/RSSHub/issues)，以确保这项功能尚未被请求。 + required: true diff --git a/.github/ISSUE_TEMPLATE/rss_request_en.md b/.github/ISSUE_TEMPLATE/rss_request_en.md deleted file mode 100644 index 70111b5420b0e1..00000000000000 --- a/.github/ISSUE_TEMPLATE/rss_request_en.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: 🍰 RSS Proposal -about: Submit a new RSS proposal ---- - - - -### Website URL - -### Website description - -### What content should be included? - -### Additional description diff --git a/.github/ISSUE_TEMPLATE/rss_request_en.yml b/.github/ISSUE_TEMPLATE/rss_request_en.yml new file mode 100644 index 00000000000000..20340b6be7f516 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/rss_request_en.yml @@ -0,0 +1,82 @@ +name: 🍰 RSS Proposal +description: Submit a new RSS proposal +labels: ['RSS proposal'] + +body: + + - type: markdown + attributes: + value: | + Please ensure the RSS proposal is not listed in [documentation](https://docs.rsshub.app/en) or [issue](https://github.com/DIYgod/RSSHub/issues), website doesn't provide this kind of RSS feed, and provide all the information required by this template. + Otherwise the issue will be closed immediately. + + We are flooded with feature requests and short-handed, please try to make it yourself, the [guide](https://docs.rsshub.app/en/joinus) is a good place to start. Submit a pull request when done! + + - type: dropdown + id: category + attributes: + label: Category + multiple: false + options: + - Social Media + - New media + - News + - BBS + - Blog + - Programming + - Design + - Live + - Multimedia + - Pciture + - ACG + - Application Updates + - University + - Forecast + - Travel + - Shopping + - Gaming + - Reading + - Government + - Study + - Scientific Journal + - Finance + - Uncategorized + validations: + required: true + + - type: input + id: site-url + attributes: + label: Website URL + placeholder: https://example.com + validations: + required: true + + - type: textarea + id: description + attributes: + label: Website description + placeholder: A short description of the website + validations: + required: true + + - type: textarea + id: content + attributes: + label: What content should be included? + validations: + required: true + + - type: textarea + id: info + attributes: + label: Additional description + placeholder: Any additional information you want to share + + - type: checkboxes + id: terms + attributes: + label: This is not a duplicated rss request + options: + - label: I have searched [existing issues](https://github.com/DIYgod/RSSHub/issues) and [pull requests](https://github.com/DIYgod/RSSHub/pulls) to ensure this rss proposal has not already been requested + required: true diff --git a/.github/ISSUE_TEMPLATE/rss_request_zh.md b/.github/ISSUE_TEMPLATE/rss_request_zh.md deleted file mode 100644 index eb3c8f849e3d0c..00000000000000 --- a/.github/ISSUE_TEMPLATE/rss_request_zh.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: 🍰 RSS 提案 -about: 提交新的 RSS 提案 ---- - - - -### 网站地址 - -### 网站描述 - -### 需要生成什么内容？ - -### 额外描述 diff --git a/.github/ISSUE_TEMPLATE/rss_request_zh.yml b/.github/ISSUE_TEMPLATE/rss_request_zh.yml new file mode 100644 index 00000000000000..501994bee268e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/rss_request_zh.yml @@ -0,0 +1,83 @@ +name: 🍰 RSS 提案 +description: 提交新的 RSS 提案 +labels: ['RSS proposal'] + +body: + + - type: markdown + attributes: + value: | + 请确保 [文档](https://docs.rsshub.app) 和 [issue](https://github.com/DIYgod/RSSHub/issues) 中没有相关内容，且源站没有提供 RSS，并按照模版提供信息 + 否则 issue 将被立即关闭 + + 目前 RSS 提案滞销，如有能力请按照 [指南](https://docs.rsshub.app/joinus) 自行编写并提交 PR + + - type: dropdown + id: category + attributes: + label: 类型 + multiple: false + options: + - 社交媒体 + - 新媒体 + - 传统媒体 + - 论坛 + - 博客 + - 编程 + - 设计 + - 直播 + - 音视频 + - 图片 + - 二次元 + - 程序更新 + - 大学通知 + - 预报预警 + - 出行旅游 + - 购物 + - 游戏 + - 阅读 + - 政务消息 + - 学习 + - 科学期刊 + - 金融 + - 其他 + validations: + required: true + + - type: input + id: site-url + attributes: + label: 网站地址 + placeholder: https://example.com + validations: + required: true + + - type: textarea + id: description + attributes: + label: 网站描述 + placeholder: 对网站的简短描述 + validations: + required: true + + - type: textarea + id: content + attributes: + label: 需要生成什么内容？ + validations: + required: true + + - type: textarea + id: info + attributes: + label: 额外描述 + placeholder: 如果提案需要额外描述，请在此处填写 + + - type: checkboxes + id: terms + attributes: + label: 这不是重复的 RSS 请求 + options: + - label: 我已经搜索了[现有 issue](https://github.com/DIYgod/RSSHub/issues) 和 [pull requests](https://github.com/DIYgod/RSSHub/pulls)，以确保该 RSS 尚未被请求。 + required: true + diff --git a/.prettierignore b/.prettierignore index 105edfc27a64dd..b4a96659f02487 100644 --- a/.prettierignore +++ b/.prettierignore @@ -2,7 +2,6 @@ package.json docs/.vuepress/dist package-lock.json .github/*.md -.github/ISSUE_TEMPLATE/*.md renovate.json coverage .vscode/