Skip to content

Commit cc6c8a5

Browse files
zzzhangqizzzhangqi
authored
feat: update issue template (#2143)
Signed-off-by: Qi Zhang <[email protected]>
1 parent 9782bd7 commit cc6c8a5

File tree

9 files changed

+291
-73
lines changed

9 files changed

+291
-73
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/cn_bug_report.yml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: 🐞 反馈问题
2+
description: Report a bug
3+
title: "🐞 反馈问题：请填写标题，不要留空"
4+
labels: ["Bug"]
5+
assignees: ["zzzhangqi"]
6+
7+
body:
8+
- type: checkboxes
9+
id: checklist
10+
attributes:
11+
label: 请先确认以下事项：
12+
options:
13+
- label: 请务必查看[常见问题](https://www.rainbond.com/docs/faq)和[故障排除](https://www.rainbond.com/docs/troubleshooting)
14+
required: true
15+
- label: 在 [issues](https://github.com/goodrain/rainbond/issues) 页面搜索过问题（包括已关闭的 issue），但未能找到解决方法
16+
required: true
17+
- label: Rainbond 已升级到 [最新版本](https://github.com/goodrain/rainbond/releases)
18+
required: true
19+
20+
- type: textarea
21+
id: description
22+
attributes:
23+
label: 问题描述
24+
description: |
25+
请详练描述你所遇到的问题，确保能够理解、重现该问题。如果上下文信息不足，会导致无法定位，问题会被降低优先级或忽略。
26+
一个 issue 只描述一个问题，如果有多个问题，请分开提交。
27+
placeholder: 问题描述
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
id: reproducible
33+
attributes:
34+
label: 该问题是否可以稳定重现？
35+
multiple: false
36+
options:
37+
- 可重现
38+
- 不可重现
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: reproduce
44+
attributes:
45+
label: 重现步骤
46+
description: |
47+
如果该问题可重现，请一定要详细提供重现步骤，否则无法定位问题。
48+
placeholder: 重现步骤
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: screenshot
54+
attributes:
55+
label: 截图
56+
description: |
57+
请提供问题截图。若截图不便于描述问题，请提供录屏，方便排查。
58+
placeholder: 请提供问题相关截图
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: log
64+
attributes:
65+
label: 日志
66+
description: "请提供日志，平台管理 -> 日志。"
67+
placeholder: 请提供日志
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: expected
73+
attributes:
74+
label: 期望结果
75+
description: 请描述您期望的结果。
76+
placeholder: 你期望的结果
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: resolution
82+
attributes:
83+
label: 解决方案（可选）
84+
description: 对于该问题，您有什么预想的解决方案，或者建议？
85+
placeholder: 你的解决方案
86+
87+
- type: input
88+
id: device
89+
attributes:
90+
label: 操作系统 && Rainbond 版本
91+
description: 请提供操作系统版本、K8s版本和 Rainbond 版本，方便排查。
92+
placeholder: Ubuntu 22.04, K8s 1.29.7, Rainbond v6.1.1-release
93+
validations:
94+
required: true
95+
96+
- type: checkboxes
97+
id: PR
98+
attributes:
99+
label: 是否愿意提交 PR 解决该问题？
100+
description: 我们非常欢迎您提交 PR，提交 PR 是解决该问题最快的方式。
101+
options:
102+
- label: 我愿意提交 PR 来解决该问题

‎.github/ISSUE_TEMPLATE/cn_feature_request.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: 🚀 功能建议
2+
description: Request a new feature
3+
title: "🚀 功能建议：请填写标题，不要留空"
4+
labels: ["Feature"]
5+
assignees: ["zzzhangqi"]
6+
7+
body:
8+
- type: textarea
9+
id: feature_description
10+
attributes:
11+
label: 功能描述
12+
description: 请描述你希望的功能，有必要的话可以提供截图，以供参考。
13+
placeholder: 功能描述
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: feature_usecase
19+
attributes:
20+
label: 使用场景
21+
description: |
22+
请描述你希望功能的使用场景。
23+
如果该功能没有明确的使用场景，或是无法被理解，可能会被降低优先级或忽略，因此请务必清晰描述。
24+
placeholder: 使用场景
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: resolution
30+
attributes:
31+
label: 实现方案（可选）
32+
description: 对于该功能，您有什么预想的实现方案，或者建议？
33+
placeholder: 实现方案
34+
35+
- type: checkboxes
36+
id: PR
37+
attributes:
38+
label: 是否愿意提交 PR 实现该功能
39+
description: 我们非常欢迎您提交 PR，提交 PR 是实现该功能的最快的方式。
40+
options:
41+
- label: 我愿意提交 PR 实现该功能

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/en_bug_report.yml‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: 🐞 Bug report
2+
description: Report a bug
3+
title: "🐞 Bug report: Please fill in the title, do not leave blank"
4+
labels: ["Bug"]
5+
assignees: ["zzzhangqi"]
6+
7+
body:
8+
- type: checkboxes
9+
id: checklist
10+
attributes:
11+
label: Please confirm the following items
12+
options:
13+
- label: Please read the [FAQ](https://www.rainbond.com/docs/faq) and [troubleshooting](https://www.rainbond.com/docs/troubleshooting) documents
14+
required: true
15+
- label: Search for the issue in the [issues](https://github.com/goodrain/rainbond/issues) page, but could not find a solution
16+
required: true
17+
- label: Rainbond has been upgraded to the [latest version](https://github.com/goodrain/rainbond/releases)
18+
required: true
19+
20+
- type: textarea
21+
id: description
22+
attributes:
23+
label: Problem description
24+
description: |
25+
Please describe the problem in detail, ensuring that the issue can be understood and reproduced. If the context is insufficient, the issue may be downgraded in priority or ignored.
26+
A single issue should only describe one problem, if there are multiple problems, please submit separate issues.
27+
placeholder: Problem description
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
id: reproducible
33+
attributes:
34+
label: Can the problem be reproduced?
35+
multiple: false
36+
options:
37+
- Reproducible
38+
- Not reproducible
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: reproduce
44+
attributes:
45+
label: Reproduce steps
46+
description: |
47+
If the problem can be reproduced, please provide detailed reproduction steps, otherwise the issue will be downgraded in priority or ignored.
48+
placeholder: Reproduce steps
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: screenshot
54+
attributes:
55+
label: Screenshot
56+
description: |
57+
Please provide relevant screenshots to describe the problem. If the screenshots are not convenient, please provide a recording to make it easier to diagnose.
58+
placeholder: Please provide relevant screenshots
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: log
64+
attributes:
65+
label: Log
66+
description: "Please provide logs, go to Platform Management -> Logs."
67+
placeholder: Please provide logs
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: expected
73+
attributes:
74+
label: Expected results
75+
description: Please describe the expected results.
76+
placeholder: Expected results
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: resolution
82+
attributes:
83+
label: Resolution
84+
description: "Please describe the resolution to the problem, or provide suggestions."
85+
placeholder: Your resolution
86+
validations:
87+
required: true
88+
89+
- type: input
90+
id: device
91+
attributes:
92+
label: Operating system && Rainbond version
93+
description: Please provide the operating system version, K8s version and Rainbond version, which can help diagnose the problem.
94+
placeholder: Ubuntu 22.04, K8s 1.29.7, Rainbond v6.1.1-release
95+
validations:
96+
required: true
97+
98+
- type: checkboxes
99+
id: PR
100+
attributes:
101+
label: Is it OK to submit a PR to solve the problem?
102+
description: We welcome you to submit a PR to solve the problem the fastest way.
103+
options:
104+
- label: I want to submit a PR to implement the feature

‎.github/ISSUE_TEMPLATE/en_feature_request.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 🚀 Feature request
2+
description: Request a new feature
3+
title: "🚀 Feature request: Please fill in the title, do not leave blank"
4+
labels: ["Feature"]
5+
assignees: ["zzzhangqi"]
6+
7+
body:
8+
- type: textarea
9+
id: feature_description
10+
attributes:
11+
label: Feature description
12+
description: Please describe the feature, with screenshots if necessary.
13+
placeholder: Feature description
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: feature_usecase
19+
attributes:
20+
label: Use case
21+
description: |
22+
Please describe the use case of the feature.
23+
If the feature does not have a clear use case, or is unclear, it may be ignored or downgraded in priority, so please be as clear as possible.
24+
placeholder: Use case
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: resolution
30+
attributes:
31+
label: Implementation plan (optional)
32+
description: Please describe the implementation plan if necessary.
33+
placeholder: Implementation plan
34+
validations:
35+
required: true
36+
37+
- type: checkboxes
38+
id: PR
39+
attributes:
40+
label: Whether to submit a PR to implement the feature
41+
description: We welcome your PR to implement the feature, the fastest way to implement the feature is to submit a PR.
42+
options:
43+
- label: I want to submit a PR to implement the feature

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/use_case.md‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)