Skip to content

Commit

Permalink
chore(docs): switch to issue forms (DIYgod#8624)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tony authored Dec 2, 2021
1 parent 1e87970 commit 11e2d4d
Show file tree
Hide file tree
Showing 13 changed files with 421 additions and 148 deletions.
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report_en.md

This file was deleted.

86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_en.yml
Original file line number Diff line number Diff line change
@@ -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
47 changes: 0 additions & 47 deletions .github/ISSUE_TEMPLATE/bug_report_zh.md

This file was deleted.

88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_zh.yml
Original file line number Diff line number Diff line change
@@ -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
15 changes: 0 additions & 15 deletions .github/ISSUE_TEMPLATE/feature_request_en.md

This file was deleted.

41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request_en.yml
Original file line number Diff line number Diff line change
@@ -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
15 changes: 0 additions & 15 deletions .github/ISSUE_TEMPLATE/feature_request_zh.md

This file was deleted.

41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request_zh.yml
Original file line number Diff line number Diff line change
@@ -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
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/rss_request_en.md

This file was deleted.

Loading

0 comments on commit 11e2d4d

Please sign in to comment.