Skip to content

Commit 5a67399

Browse files
authored
ci: 🎡 修改issue模板 (#30)
1 parent 7afd913 commit 5a67399

2 files changed

Lines changed: 117 additions & 45 deletions

File tree

.github/ISSUE_TEMPLATE/BUGS.yml

Lines changed: 68 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,45 @@
1-
name: "\U0001F41B Bug Report"
2-
description: "If something isn't working as expected \U0001F914"
1+
name: '🐛 Bug 报告'
2+
description: '发现了问题?请告诉我们 🤔'
33
labels: ['needs triage', 'bug']
44
body:
55
- type: textarea
66
validations:
77
required: true
88
attributes:
9-
label: 'Current behavior'
10-
description: 'How the issue manifests?'
9+
label: '当前行为(Bug 描述)'
10+
description: '这个问题是如何表现的?请详细描述当前的错误行为'
11+
placeholder: |
12+
当我尝试...时,发生了...
13+
预期应该...,但实际上...
1114
1215
- type: input
1316
validations:
1417
required: true
1518
attributes:
16-
label: 'Minimum reproduction code'
17-
description: 'An URL to some git repository or gist that reproduces this issue. [Wtf is a minimum reproduction?](https://jmcdo29.github.io/wtf-is-a-minimum-reproduction)'
18-
placeholder: 'https://github.com/...'
19+
label: '重现代码或链接'
20+
description: '提供能重现此问题的代码片段、截图或者在线链接。什么是最小重现?请尽可能简化问题'
21+
placeholder: '请提供截图、代码片段或问题链接'
1922

2023
- type: textarea
2124
attributes:
22-
label: 'Steps to reproduce'
25+
label: '重现步骤'
2326
description: |
24-
How the issue manifests?
25-
You could leave this blank if you alread write this in your reproduction code/repo
27+
详细的重现步骤,帮助我们快速定位问题
2628
placeholder: |
27-
1. `npm i`
28-
2. `npm start:dev`
29-
3. See error...
29+
1. 打开文档编辑器
30+
2. 点击...按钮
31+
3. 输入...
32+
4. 看到错误...
3033
3134
- type: textarea
3235
validations:
3336
required: true
3437
attributes:
35-
label: 'Expected behavior'
36-
description: 'A clear and concise description of what you expected to happend (or code)'
38+
label: '预期行为'
39+
description: '清楚简洁地描述你期望发生的行为'
40+
placeholder: |
41+
我期望...
42+
系统应该...
3743
3844
- type: markdown
3945
attributes:
@@ -44,37 +50,62 @@ body:
4450
validations:
4551
required: true
4652
attributes:
47-
label: 'Package version'
53+
label: 'DocFlow 版本'
4854
description: |
49-
Which version of `@nestjs/cli` are you using?
50-
**Tip**: Make sure that all of yours `@nestjs/*` dependencies are in sync!
51-
placeholder: '8.1.3'
55+
你使用的 DocFlow 版本是什么?可以在设置页面或者浏览器控制台查看
56+
placeholder: 'v1.0.0 或 commit hash'
5257

5358
- type: dropdown
5459
attributes:
55-
label: 'Template Package'
56-
description: 'Which project template are you using?'
60+
label: '问题类型'
61+
description: '这个 Bug 主要影响哪个功能?'
5762
options:
58-
- react-web-ts
59-
- vue-web-js
60-
- react-web-js
61-
- vue-web-ts
63+
- 文档编辑器
64+
- 协作功能
65+
- 文件管理
66+
- 用户认证
67+
- 图片/媒体处理
68+
- 导入/导出
69+
- 用户界面
70+
- 性能问题
71+
- 其他
6272
validations:
6373
required: true
6474

65-
- type: input
75+
- type: dropdown
6676
attributes:
67-
label: 'Node.js version'
68-
description: 'Which version of Node.js are you using?'
69-
placeholder: '14.17.6'
77+
label: '浏览器'
78+
description: '在哪个浏览器中遇到了问题?'
79+
options:
80+
- Chrome
81+
- Firefox
82+
- Safari
83+
- Edge
84+
- 其他 (请在下面的"其他信息"中说明)
85+
validations:
86+
required: true
7087

7188
- type: checkboxes
7289
attributes:
73-
label: 'In which operating systems have you tested?'
90+
label: '你在哪些操作系统上测试过?'
7491
options:
7592
- label: macOS
7693
- label: Windows
7794
- label: Linux
95+
- label: iOS (Mobile Safari)
96+
- label: Android
97+
98+
- type: dropdown
99+
attributes:
100+
label: '问题严重程度'
101+
description: '这个问题对你的使用有多大影响?'
102+
options:
103+
- 低 - 不影响正常使用
104+
- 中 - 有些不便但有替代方案
105+
- 高 - 严重影响使用体验
106+
- 紧急 - 完全无法使用某功能
107+
validations:
108+
required: true
78109

79110
- type: markdown
80111
attributes:
@@ -83,7 +114,11 @@ body:
83114
84115
- type: textarea
85116
attributes:
86-
label: 'Other'
117+
label: '其他信息'
87118
description: |
88-
Anything else relevant? eg: Logs, OS version, IDE, package manager, etc.
89-
**Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in
119+
还有其他相关信息吗?比如:日志、错误消息、设备信息等
120+
💡 提示:你可以通过拖拽文件到这个区域来附加图片、录屏或日志文件
121+
placeholder: |
122+
浏览器控制台错误:...
123+
设备信息:...
124+
其他相关信息:...

.github/ISSUE_TEMPLATE/FEATURE.yml

Lines changed: 49 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,68 @@
1-
name: "\U0001F680 Feature Request"
2-
description: "I have a suggestion \U0001F63B!"
3-
labels: ['feature']
1+
name: '🚀 功能请求'
2+
description: '我有一个功能建议 💡'
3+
labels: ['enhancement', 'feature']
44
body:
55
- type: textarea
66
validations:
77
required: true
88
attributes:
9-
label: 'Is your feature request related to a problem? Please describe it'
10-
description: 'A clear and concise description of what the problem is'
9+
label: '功能请求是否与某个问题相关?请详细描述'
10+
description: '清楚简洁地描述你遇到的问题或需求'
1111
placeholder: |
12-
I have an issue when ...
12+
我在使用文档编辑器时遇到了...
13+
或者:我希望能够...
1314
1415
- type: textarea
1516
validations:
1617
required: true
1718
attributes:
18-
label: "Describe the solution you'd like"
19-
description: 'A clear and concise description of what you want to happen. Add any considered drawbacks'
19+
label: '描述你希望的解决方案'
20+
description: '清楚简洁地描述你希望实现的功能。如果有任何考虑到的缺点,也请添加'
21+
placeholder: |
22+
我希望能够...
23+
这个功能应该...
2024
2125
- type: textarea
2226
attributes:
23-
label: 'Teachability, documentation, adoption, migration strategy'
24-
description: 'If you can, explain how users will be able to use this and possibly write out a version the docs. Maybe a screenshot or design?'
27+
label: '功能的使用场景和用户体验'
28+
description: '如果可以的话,请解释用户将如何使用这个功能。也许可以提供截图或设计稿?'
29+
placeholder: |
30+
用户可以通过...来使用这个功能
31+
预期的用户体验是...
2532
2633
- type: textarea
2734
validations:
2835
required: true
2936
attributes:
30-
label: 'What is the motivation / use case for changing the behavior?'
31-
description: 'Describe the motivation or the concrete use case'
37+
label: '改变现有行为的动机/用例是什么?'
38+
description: '描述添加此功能的动机或具体用例'
39+
placeholder: |
40+
这个功能对于文档协作很重要,因为...
41+
或者:当前的工作流程中缺少...
42+
43+
- type: dropdown
44+
attributes:
45+
label: '功能类型'
46+
description: '这个功能主要属于哪个方面?'
47+
options:
48+
- 文档编辑器
49+
- 协作功能
50+
- 文件管理
51+
- 用户界面
52+
- 性能优化
53+
- 安全性
54+
- 其他
55+
validations:
56+
required: true
57+
58+
- type: dropdown
59+
attributes:
60+
label: '优先级'
61+
description: '你认为这个功能的优先级如何?'
62+
options:
63+
- 低 - 有了更好
64+
- 中 - 希望尽快实现
65+
- 高 - 对产品很重要
66+
- 紧急 - 阻碍了正常使用
67+
validations:
68+
required: true

0 commit comments

Comments
 (0)