Skip to content

Commit 7dfc517

Browse files
committed
docs(issue): add formated issue template.
1 parent 5519740 commit 7dfc517

File tree

2 files changed

+89
-42
lines changed

2 files changed

+89
-42
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug-report-ZH.md

-42
This file was deleted.

Diff for: .github/ISSUE_TEMPLATE/bug-report-ZH.yaml

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
name: 提交一个问题
2+
description: 来帮助我们一起完善 BIThesis 吧!
3+
title: "[Bug]: 在这里概括你的问题"
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢你抽出宝贵的时间来提交这个问题!
10+
- type: textarea
11+
id: what-happened
12+
attributes:
13+
label: 发生了什么?
14+
description: 请描述你遇到的问题。
15+
placeholder: _清晰而简明地描述我所遇到的问题。_
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: what-happened
20+
attributes:
21+
label: 你期望的结果
22+
description: 提供一下你期望的结果。
23+
placeholder: _简述我期望得到的正确结果。_
24+
validations:
25+
required: false
26+
- type: textarea
27+
id: step-to-reproduce
28+
attributes:
29+
label: 问题复现的步骤
30+
description: 我们如何才能帮你复现这个问题?
31+
placeholder: |
32+
1. 打开 '...'
33+
2. 点击 '...'
34+
3. 移动到 '...'
35+
4. 就能看见这个问题 '...'
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: MRE
40+
attributes:
41+
label: 最小可复现用例或者截图
42+
description: 如果问题比较复杂,请考虑提供一个能够供我们编译的、可复现的示例。
43+
placeholder: |
44+
45+
_(首选)提供一个“[最小可复现用例](https://en.wikipedia.org/wiki/Minimal_working_example)”,
46+
请注意删除任何可能泄漏的重要信息,我们将不会对其中的信息泄漏问题负责。_
47+
48+
_(备选,但不推荐)请提供关键信息的截图来描述问题。注意请尽可能地截全。_
49+
validations:
50+
required: false
51+
- type: dropdown
52+
id: os
53+
attributes:
54+
label: 操作系统或平台
55+
description: 你使用的操作系统或平台是什么?
56+
options:
57+
- Windows
58+
- macOS
59+
- Linux
60+
- Overleaf
61+
validations:
62+
required: false
63+
- type: input
64+
id: software-version
65+
attributes:
66+
label: LaTeX 发行版以及发行年份
67+
placeholder: TexLive 2021
68+
validations:
69+
required: false
70+
- type: dropdown
71+
id: os
72+
attributes:
73+
label: BIThesis 模板
74+
description: 你遇到问题的模板有哪些?
75+
multiple: true
76+
options:
77+
- lab-report
78+
- master-thesis
79+
- paper-translation
80+
- presentation-slide
81+
- undergraduate-proposal-report
82+
- undergraduate-thesis
83+
- type: textarea
84+
id: logs
85+
attributes:
86+
label: 日志信息
87+
description: 请复制并粘贴任何相关的日志输出。这将被自动格式化为代码,所以不需要“`”符号。
88+
render: shell
89+

0 commit comments

Comments
 (0)