Skip to content

Commit db1424e

Browse files
committed
chore: add issue templates
1 parent 19100c1 commit db1424e

File tree

4 files changed

+32
-1
lines changed

4 files changed

+32
-1
lines changed

.github/ISSUE_TEMPLATE/bug.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: BUG
3-
about: Report bugs
3+
about: Report bugs 报告 BUG
44
title: "[BUG]"
55
labels: bug
66
assignees: ''
+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature request 功能建议
3+
about: Want to add or optimize some features 希望增加或优化某些功能
4+
title: "[Feature Request]"
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Feature description 功能描述
11+
For example, when type some keys, something will happen. You can also add some diagrams to make it easier for others to understand what you mean.
12+
例如:按了某个键,会发生什么事。您也可以加上一些示意图,来方便其他人理解你的意思。
13+
14+
## Similar product 类似功能
15+
If there are similar functions in other projects, you can attach them here to help us understand the function.
16+
如果其他项目中有类似功能,可以在此附上,方便我们理解该功能的作用。

.github/ISSUE_TEMPLATE/question.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Question 提问
3+
about: Questions in use 使用上的问题
4+
title: "[Question]"
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
## Please note 提问前请注意
11+
* This option is used to ask others some usage questions. If you confirm this is a bug, please submit a bug.
12+
* Please read [How To Ask Questions](http://www.catb.org/~esr/faqs/smart-questions.html) before asking questions. Inefficient questions not only waste other people's time, but also keep you from getting timely answers.
13+
* 该选项用来向其他人询问一些使用上的问题,如果你确认这是一个BUG,请提交BUG。
14+
* 提问前,请先阅读[提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)。低效的问题不仅会浪费其他人的时间,也会使你无法得到及时的解答。

docs/faq.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# FAQ

0 commit comments

Comments
 (0)