Skip to content

Commit

Permalink
chore: change the templates of bug/suggestion report (#5019)
Browse files Browse the repository at this point in the history
Since there're too many issues' reports unsuitable and without detail
information, this has puzzled us too much. Here's a list of templates
for us to force the users to input what you want step by step
  • Loading branch information
Wai-Dung committed Sep 20, 2022
1 parent 64dd9fe commit bbd0e43
Show file tree
Hide file tree
Showing 10 changed files with 232 additions and 106 deletions.
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report-cn.yml
@@ -0,0 +1,65 @@
name: 🐛 Egg Bug 反馈
description: 如发现 Egg 框架中的 Bug,请及时在此汇报。
labels: [bug]
body:
- type: textarea
attributes:
label: |
在此输入你需要反馈的 Bug 具体信息(Bug in Detail):
placeholder: |
1. 我做了什么。
2. 我的预期值。
3. 我实际得到的结果。
4. 可以的话,请提供一些截图、视频作为附件以复现症状。
validations:
required: true
- type: textarea
attributes:
label: 可复现问题的仓库地址(Reproduction Repo)
description: |
1. 请使用 `npm init egg --type=simple bug` 创建最小可复现问题的代码。
2. 在 GitHub 中上传该代码项目,并在此处粘贴地址。你也可以直接将你的仓库压缩为 zip 文件直接以附件形式提交。
placeholder: |
https://github.com/YOUR_REPOSITORY_URL
validations:
required: true
- type: input
attributes:
label: Node 版本号:
description: |
你的当前复现问题的 Node 版本号:
placeholder: |
使用 “node -v” 命令,在控制台得到版本号(例如:v8.5.0)。
validations:
required: true
- type: input
attributes:
label: Eggjs 版本号:
description: |
你的当前复现问题 Eggjs 版本号:
placeholder: |
请直接在“package.json”中查阅(例如:3.1.0)。
validations:
required: true
- type: input
attributes:
label: "相关插件名称与版本号(PlugIn and Name):"
description: |
插件名称以及版本号:
placeholder: |
请直接在“package.json”中查阅(例如:egg-mysql,3.1.1)。
validations:
required: true
- type: input
attributes:
label: "操作平台与版本号(Platform and Version):"
description: |
你的操作平台与版本号:
placeholder: |
Windows 10 专业版(21H2)
validations:
required: true
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,65 @@
name: 🐛 Bug Report For Eggjs
description: Report an issue if something isn't working as expected 🤔.
labels: [bug]
body:
- type: textarea
attributes:
label: |
Your detail info about the Bug:
placeholder: |
1. What I did.
2. What I expected to happen.
3. What I actually got.
4. If possible, images/videos as attachments are welcomed to show the bug.
validations:
required: true
- type: textarea
attributes:
label: Reproduction Repo
description: |
1. Please use `npm init egg --type=simple bug` to create your smallest repo.
2. Submit it in the GitHub and paste your URL here. You can also attach your zip file directly.
placeholder: |
https://github.com/YOUR_REPOSITORY_URL or your zip file
validations:
required: true
- type: input
attributes:
label: Node Version
description: |
What's your Node's version?
placeholder: |
Use "node -v" in your console to get it (e.g: v8.5.0).
validations:
required: true
- type: input
attributes:
label: Eggjs Version
description: |
What's your Eggjs version?
placeholder: |
See it directly in your "package.json" file (e.g: 3.1.0)
validations:
required: true
- type: input
attributes:
label: Plugin Name and its version
description: |
What's your plugin's name and version?
placeholder: |
See them directly in your "package.json" file (e.g: egg-mysql, 3.1.1)
validations:
required: true
- type: input
attributes:
label: Platform and its version
description: |
What's your platform and its version?
placeholder: |
Windows 10 Professional(21H2)
validations:
required: true
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report_cn.md

This file was deleted.

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request-cn.yml
@@ -0,0 +1,21 @@
name: 💡 我有一个新点子
description: 我对 Eggjs 框架有一个新的想法(或许我想来实现他)……
labels: [feature request]
body:
- type: markdown
attributes:
value: |
对于 Egg.js 框架,你有一个新的想法?
不过在提交你的新点子之前,麻烦请检阅一下是否之前的帖子中有类似重复的内容。
- type: textarea
attributes:
label: 请详细告知你的新点子(Nice Ideas):
placeholder: |
1. 您期望能够实现什么功能。
2. 您的理由(如:我一直被什么问题困扰……)。
如果方便的话,请提供截屏或者视频等详细信息。
3. 我能够做一些什么(最好是能提供一些伪代码帮助实现)。
validations:
required: true
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,23 @@
name: 💡 Feature Request For Eggjs
description: I have a suggestion (and may want to implement it)!
labels: [feature request]
body:
- type: markdown
attributes:
value: |
You have an idea how to improve the Eggjs?
Before submitting, please have a look at the existing issues if there's already
something related to your suggestion.
- type: textarea
attributes:
label: "Enter your suggestions in details:"
placeholder: |
1. What I expected to happen?
2. Your reason (e.g: I'm always frustrated with...).
If possible, images or videos are welcome.
3. What I plan to do (Optional but better in pseudo codes).
validations:
required: true
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/rfc-cn.yml
@@ -0,0 +1,27 @@
name: 🚀 RFC 提案
description: 我对 Eggjs 框架技术架构功能层面上有重大新增、改进等。
labels: [RFC proposal]
body:
- type: markdown
attributes:
value: |
对于 Eggjs 框架功能你是否有重大的新增或改进之类的想法?
不过在提交你的新想法或方案之前,麻烦请检阅一下是否之前的帖子中有类似重复的内容。
- type: textarea
attributes:
label: 请详细告知你的新解决思路(Your new RFCs):
placeholder: |
1. 描述你希望解决的问题的现状,附上相关的 issue 地址。
如果方便的话,请提供截屏或者视频等详细信息。
2. 我能够做一些什么(譬如具体相关的的 API,描述思路,最好是能提供一些伪代码帮助实现)。
validations:
required: true
- type: checkboxes
attributes:
label: "跟进类型(Follow-up Types):"
description: 此议案跟进类型情况:
options:
- label: 这是某个任务
- label: 这是一个具体的 PR 的地址(URL)
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/rfc.yml
@@ -0,0 +1,31 @@
name: 🚀 RFC Proposals
description: I've got a major improvement (or idea) on the technical architecture of the Eggjs framework.
labels: [RFC proposal]
body:
- type: markdown
attributes:
value: |
Any better new/changable functions for the core technical architecture of the Egg.js framework?
But please make sure there's no duplicated issues related to your idea before submitting.
- type: textarea
attributes:
label: "Please describe your idea in detail:"
placeholder: |
1. Describe the current situation of the problem you want to solve,
and attach the related issue address.
If it is possible, please provide screenshots or videos in detail.
2. What can I do (related APIs, Your ideas, better to provide some pseudo code to help implementations).
validations:
required: true
- type: checkboxes
attributes:
label: Follow-up type
description: The type of the RFC proposals.
options:
- label: Some Task
- label: PR URL(s)
validations:
required: true
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/rfc_cn.md

This file was deleted.

1 comment on commit bbd0e43

@vercel
Copy link

@vercel vercel bot commented on bbd0e43 Sep 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

egg – ./

egg-git-master-suyi.vercel.app
egg-pi.vercel.app
eggjs.org
egg-suyi.vercel.app
www.eggjs.org

Please sign in to comment.