Skip to content

Commit d60d881

Browse files
authored
docs: ✏️ add issue template (#193)
1 parent 4e90f36 commit d60d881

File tree

3 files changed

+60
-24
lines changed

3 files changed

+60
-24
lines changed
Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,50 @@
1-
name: 🐞 Bug
2-
description: 提交错误报告 | File a bug/issue
3-
title: "[BUG] <title>"
4-
labels: []
1+
name: 🐞 Bug report
2+
description: Report errors or unexpected behavior | 提交Bug或求助信息
3+
title: "[🐞] <title>"
4+
labels:
5+
- bug
6+
- needs-triaged
57
body:
68
- type: checkboxes
79
attributes:
8-
label: 是否已有关于该错误的issue或讨论? | Is there an existing issue / discussion for this?
10+
label: Is there an existing issue / discussion for this? | 是否已有关于该错误的issue或讨论?
911
description: |
10-
请先搜索您遇到的错误是否在已有的issues或讨论中提到过。
1112
Please search to see if an issue / discussion already exists for the bug you encountered.
13+
请先搜索您遇到的错误是否在已有的issues或讨论中提到过。
1214
[Issues](https://github.com/GestaltCogTeam/BasicTS/issues)
1315
options:
14-
- label: 我已经搜索过已有的issues和讨论 | I have searched the existing issues / discussions
16+
- label: I have searched the existing issues / discussions | 我已经搜索过已有的issues和讨论
1517
required: true
1618
- type: checkboxes
1719
attributes:
18-
label: 该问题是否在教程中有解答? | Is there an existing answer for this in tutorial?
20+
label: Is there an existing answer for this in tutorial? | 该问题是否在教程中有解答?
1921
description: |
20-
请先搜索您遇到的错误是否已在tutorial中有相关解答。
2122
Please search to see if an answer already exists in tutorial for the bug you encountered.
23+
请先搜索您遇到的错误是否已在tutorial中有相关解答。
2224
[tutorial-en](https://github.com/GestaltCogTeam/BasicTS/blob/master/tutorial/getting_started.md)
2325
[tutorial-zh](https://github.com/GestaltCogTeam/BasicTS/blob/master/tutorial/getting_started_cn.md)
2426
options:
25-
- label: 我已经搜索过tutorial | I have searched tutorial
27+
- label: I have searched tutorial | 我已经搜索过tutorial
2628
required: true
2729
- type: textarea
2830
attributes:
29-
label: 当前行为 | Current Behavior
31+
label: Current Behavior | 当前行为
3032
description: |
31-
准确描述遇到的行为。
3233
A concise description of what you're experiencing.
34+
准确描述遇到的行为。
3335
validations:
3436
required: false
3537
- type: textarea
3638
attributes:
37-
label: 期望行为 | Expected Behavior
39+
label: Expected Behavior | 期望行为
3840
description: |
39-
准确描述预期的行为。
4041
A concise description of what you expected to happen.
42+
准确描述预期的行为。
4143
validations:
4244
required: false
4345
- type: textarea
4446
attributes:
45-
label: 运行环境 | Environment
47+
label: Environment | 运行环境
4648
description: |
4749
examples:
4850
- **OS**: Ubuntu 22.04.2
@@ -63,22 +65,22 @@ body:
6365
required: false
6466
- type: textarea
6567
attributes:
66-
label: BasicTS日志 | BasicTS logs
68+
label: BasicTS logs | BasicTS日志
6769
description: |
68-
在checkpoints下找到training_log_xxx.log,把关键信息粘贴到这里。
6970
Find the training_log_xxx.log file in the directory of checkpoints and paste the key information here.
71+
在checkpoints下找到training_log_xxx.log,把关键信息粘贴到这里。
7072
placeholder: |
71-
把training_log_xxx.log的关键内容贴到这里
7273
paste training_log_xxx.log key content here.
74+
把training_log_xxx.log的关键内容贴到这里
7375
validations:
7476
required: false
7577

7678
- type: textarea
7779
attributes:
78-
label: 复现方法 | Steps To Reproduce
80+
label: Steps To Reproduce | 复现方法
7981
description: |
80-
复现当前行为的详细步骤。
8182
Steps to reproduce the behavior.
83+
复现当前行为的详细步骤。
8284
placeholder: |
8385
1. In this environment...
8486
2. With this config...
@@ -89,14 +91,15 @@ body:
8991

9092
- type: textarea
9193
attributes:
92-
label: 备注 | Anything else?
94+
label: Anything else? | 备注
9395
description: |
96+
Links? References? Anything that will give us more context about the issue you are encountering!
97+
98+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
99+
94100
您可以在这里补充其他关于该问题背景信息的描述、链接或引用等。
95101
96102
您可以通过点击高亮此区域然后拖动文件的方式上传图片或日志文件。
97103
98-
Links? References? Anything that will give us more context about the issue you are encountering!
99-
100-
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
101104
validations:
102105
required: false

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: "\U0001F4DA BaiscTS user documentation"
4+
url: https://github.com/GestaltCogTeam/BasicTS/blob/master/tutorial/getting_started.md
5+
about: Documentation for users of BaiscTS
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: "⭐ Feature or enhancement request"
2+
description: Propose something new | 提出新需求
3+
title: "[⭐] <title>"
4+
labels:
5+
- needs-triaged
6+
- enhancement
7+
body:
8+
- type: textarea
9+
attributes:
10+
label: Description of the new feature / enhancement | 您所需的新功能或能力
11+
placeholder: What is the expected behavior of the proposed feature? | 请描述下您所需的新功能或能力的预期行为
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Scenario when this would be used? | 使用场景
17+
placeholder: What is the scenario this would be used? | 请描述下您的应用场景
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Supporting information | 附加信息
23+
placeholder: "Having additional logs, papers, projects, ... anything is extremely helpful. | 附加信息,例如日志、相关论文和项目等"
24+
validations:
25+
required: false
26+
- type: markdown
27+
attributes:
28+
value: Please limit one request per issue. | 请每个请求提交一个issue

0 commit comments

Comments
 (0)