Keldos commited on
Commit
c44abaa
·
1 Parent(s): fe45f69

doc: 更新issue模板

Browse files

- 增加了server和bug两类;
- 为something went wrong增加了提示

.github/ISSUE_TEMPLATE/report-bug.md ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ name: Report Bug
3
+ about: 报告一个bug,且您确信这是bug而不是您的问题
4
+ title: "[BUG] 简短的错误描述"
5
+ labels: bug
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ > 感谢提交 issue! 请尽可能完整填写以下信息,帮助我们更好地定位问题~
11
+ > 如果您确信这是一个我们的 bug,而不是因为您的原因部署失败,欢迎提交该issue!如果您不能确定这是bug还是您的问题,请选择其他类型的issue模板。
12
+ > 注意,请编辑issue标题栏“简短的错误描述”部分,也请替换我们的issue模板中的原文。
13
+
14
+ ### 错误描述
15
+ 请简明描述该bug。
16
+
17
+ ### 复现操作
18
+ 你之前干了什么,然后出现了bug呢?例如:
19
+ 1. 正常完成本地部署
20
+ 2. 在对话框中要求 ChatGPT “以LaTeX格式输出三角函数”
21
+ 3. ChatGPT 输出部分内容后程序被自动终止
22
+
23
+ ### 错误截图
24
+ 如果可以,请提供错误的截图,如本地部署的网页截图与终端错误报告的截图。
25
+
26
+ ### 终端(控制台)中的错误报告
27
+ 如果可以,请复制终端中的主要错误报告。
28
+
29
+ ```console
30
+ (请使用错误报告替换本行)
31
+ ```
32
+
33
+ ### 运行环境
34
+ **请填写以下列表:**
35
+
36
+ - OS: [e.g. Windows11 22H2]
37
+ - Browser: [e.g. Chrome, safari]
38
+ - Gradio version:
39
+ - Python (或Python3) version:
40
+
41
+ ### 其他
42
+ 补充说明
.github/ISSUE_TEMPLATE/report-docker.md CHANGED
@@ -1,30 +1,33 @@
1
  ---
2
  name: Report Docker
3
- about: 报告使用 Docker 在服务器上部署时的错误
4
  title: "[Docker] 简短的错误描述"
5
  labels: question, docker deployment
6
  assignees: ''
7
 
8
  ---
9
 
 
 
 
10
  ### 错误描述
11
- > 请简明描述该错误。
12
 
13
  ### 复现操作
14
- > 描述出现错误的操作步骤。
15
 
16
  ### 错误截图
17
- > 如果可以,请提供错误的截图,如部署的网页截图与控制台错误报告的截图。
18
 
19
  ### 终端(控制台)中的错误报告
20
- > 如果可以,请复制终端中的主要错误报告。
21
 
22
  ```console
23
  (请使用错误报告替换本行)
24
  ```
25
 
26
  ### 运行环境
27
- > **请填写以下列表:**
28
 
29
  - OS: [e.g. Linux Ubuntu]
30
  - Docker version:
@@ -32,4 +35,4 @@ assignees: ''
32
  - Python (或Python3) version:
33
 
34
  ### 其他
35
- > 补充说明
 
1
  ---
2
  name: Report Docker
3
+ about: 报告使用 Docker 部署时的问题或错误
4
  title: "[Docker] 简短的错误描述"
5
  labels: question, docker deployment
6
  assignees: ''
7
 
8
  ---
9
 
10
+ > 感谢提交 issue! 请尽可能完整填写以下信息,帮助我们更好地定位问题~
11
+ > 请务必先查看 README 中是否已经对您的问题做出了解答。如果没有,请检索issue,查看有没有相同或类似的问题。如果您确信这是一个前人没有遇到的问题,欢迎提交该issue!注意,请编辑issue标题栏“简短的错误描述”部分,也请替换我们的issue模板中的原文。
12
+
13
  ### 错误描述
14
+ 请简明描述该错误。
15
 
16
  ### 复现操作
17
+ 描述出现错误的操作步骤。
18
 
19
  ### 错误截图
20
+ 如果可以,请提供错误的截图,如部署的网页截图与控制台错误报告的截图。
21
 
22
  ### 终端(控制台)中的错误报告
23
+ 如果可以,请复制终端中的主要错误报告。
24
 
25
  ```console
26
  (请使用错误报告替换本行)
27
  ```
28
 
29
  ### 运行环境
30
+ **请填写以下列表:**
31
 
32
  - OS: [e.g. Linux Ubuntu]
33
  - Docker version:
 
35
  - Python (或Python3) version:
36
 
37
  ### 其他
38
+ 补充说明
.github/ISSUE_TEMPLATE/report-localhost.md CHANGED
@@ -1,29 +1,30 @@
1
  ---
2
  name: Report localhost
3
- about: 报告本地部署时的错误
4
  title: "[本地部署] 简短的错误描述"
5
  labels: question, local deployment
6
  assignees: ''
7
 
8
  ---
9
 
10
- 感谢提交 issue! 请尽可能完整填写以下信息,帮助我们更好地定位问题~
11
- 如果你不知道怎么填写,请先点击编辑框上方的“Preview”在预览中查看我们的说明,然后在空白行处填写信息~
 
12
 
13
  ### 错误描述
14
- > 请简明描述该错误。另外,请注意替换issue标题中的“简短的错误描述”。
15
 
16
  ### 复现操作
17
- > 你之前干了什么,然后出现了错误呢?例如:
18
- > 1. 正常完成本地部署
19
- > 2. 在对话框中要求 ChatGPT “以LaTeX格式输出三角函数”
20
- > 3. ChatGPT 输出部分内容后程序被自动终止
21
 
22
  ### 错误截图
23
- > 如果可以,请提供错误的截图,如本地部署的网页截图与终端错误报告的截图。
24
 
25
  ### 终端(控制台)中的错误报告
26
- > 如果可以,请复制终端中的主要错误报告。
27
 
28
  ```console
29
  (请使用错误报告替换本行)
@@ -31,13 +32,13 @@ assignees: ''
31
 
32
  ### 运行环境
33
  #### 桌面系统
34
- > **请填写以下列表:**
35
 
36
- - OS: [e.g. Windows11 22H2]
37
- - Browser: [e.g. Chrome, safari]
38
 
39
  #### 运行依赖
40
- > **请填写以下列表:**
41
  > 你可以在终端中依次输入以下指令以查看软件版本:
42
  > ```shell
43
  > pip show gradio
@@ -49,4 +50,4 @@ assignees: ''
49
  - Python (或Python3) version:
50
 
51
  ### 其他
52
- > 补充说明
 
1
  ---
2
  name: Report localhost
3
+ about: 报告本地部署时的问题或错误
4
  title: "[本地部署] 简短的错误描述"
5
  labels: question, local deployment
6
  assignees: ''
7
 
8
  ---
9
 
10
+ > 感谢提交 issue! 请尽可能完整填写以下信息,帮助我们更好地定位问题~
11
+ > 请务必先查看 README 中是否已经对您的问题做出了解答。如果没有,请检索issue,查看有没有相同或类似的问题。如果您确信这是一个前人没有遇到的问题,欢迎提交该issue!注意,请编辑issue标题栏“简短的错误描述”部分,也请替换我们的issue模板中的原文。
12
+ > 如果您想问的是 `Something went wrong Expecting value: line 1 column 1 (char 0)`,请再好好看一遍 README!!
13
 
14
  ### 错误描述
15
+ 请简明描述该错误。另外,请注意替换issue标题中的“简短的错误描述”。
16
 
17
  ### 复现操作
18
+ 你之前干了什么,然后出现了错误呢?例如:
19
+ 1. 正常完成本地部署
20
+ 2. 在对话框中要求 ChatGPT “以LaTeX格式输出三角函数”
21
+ 3. ChatGPT 输出部分内容后程序被自动终止
22
 
23
  ### 错误截图
24
+ 如果可以,请提供错误的截图,如本地部署的网页截图与终端错误报告的截图。
25
 
26
  ### 终端(控制台)中的错误报告
27
+ 如果可以,请复制终端中的主要错误报告。
28
 
29
  ```console
30
  (请使用错误报告替换本行)
 
32
 
33
  ### 运行环境
34
  #### 桌面系统
35
+ **请填写以下列表:**
36
 
37
+ - OS: [例如:Windows11 22H2]
38
+ - Browser: [例如:Chrome, Safari]
39
 
40
  #### 运行依赖
41
+ **请填写以下列表:**
42
  > 你可以在终端中依次输入以下指令以查看软件版本:
43
  > ```shell
44
  > pip show gradio
 
50
  - Python (或Python3) version:
51
 
52
  ### 其他
53
+ 补充说明
.github/ISSUE_TEMPLATE/report-others.md CHANGED
@@ -1,36 +1,36 @@
1
  ---
2
  name: Report others
3
- about: 报告其他错误(如 Hugging Face 中的 Space 等)
4
  title: "[其他] 简短的错误描述"
5
  labels: question
6
  assignees: ''
7
 
8
  ---
9
 
10
- 感谢提交 issue! 请尽可能完整填写以下信息,帮助我们更好地定位问题~
11
- 如果你不知道怎么填写,请先点击编辑框上方的“Preview”在预览中查看我们的说明,然后点击“Write”在空白行处填写信息~
12
 
13
  ### 错误描述
14
- > 请简明描述该错误。
15
 
16
  ### 复现操作
17
- > 你之前干了什么,然后出现了错误呢?例如:
18
- > 1. 正常完成本地部署
19
- > 2. 在对话框中要求 ChatGPT “以LaTeX格式输出三角函数”
20
- > 3. ChatGPT 输出部分内容后程序被自动终止
21
 
22
  ### 错误截图
23
- > 如果可以,请提供错误的截图,如本地部署的网页截图与终端错误报告的截图。
24
 
25
  ### 终端(控制台)中的错误报告
26
- > 如果可以,请复制终端中的主要错误报告。
27
 
28
  ```console
29
  (请使用错误报告替换本行)
30
  ```
31
 
32
  ### 运行环境
33
- > **请填写以下列表:**
34
 
35
  - OS: [e.g. Windows11 22H2]
36
  - Browser: [e.g. Chrome, safari]
@@ -38,4 +38,4 @@ assignees: ''
38
  - Python (或Python3) version:
39
 
40
  ### 其他
41
- > 补充说明
 
1
  ---
2
  name: Report others
3
+ about: 报告其他问题(如 Hugging Face 中的 Space 等)
4
  title: "[其他] 简短的错误描述"
5
  labels: question
6
  assignees: ''
7
 
8
  ---
9
 
10
+ > 感谢提交 issue! 请尽可能完整填写以下信息,帮助我们更好地定位问题~
11
+ > 请务必先查看 README 中是否已经对您的问题做出了解答。如果没有,请检索issue,查看有没有相同或类似的问题。如果您确信这是一个前人没有遇到的问题,欢迎提交该issue!注意,请编辑issue标题栏“简短的错误描述”部分,也请替换我们的issue模板中的原文。
12
 
13
  ### 错误描述
14
+ 请简明描述该错误。另外,请注意替换issue标题中的“简短的错误描述”。
15
 
16
  ### 复现操作
17
+ 你之前干了什么,然后出现了错误呢?例如:
18
+ 1. 正常完成本地部署
19
+ 2. 在对话框中要求 ChatGPT “以LaTeX格式输出三角函数”
20
+ 3. ChatGPT 输出部分内容后程序被自动终止
21
 
22
  ### 错误截图
23
+ 如果可以,请提供错误的截图,如本地部署的网页截图与终端错误报告的截图。
24
 
25
  ### 终端(控制台)中的错误报告
26
+ 如果可以,请复制终端中的主要错误报告。
27
 
28
  ```console
29
  (请使用错误报告替换本行)
30
  ```
31
 
32
  ### 运行环境
33
+ **请填写以下列表:**
34
 
35
  - OS: [e.g. Windows11 22H2]
36
  - Browser: [e.g. Chrome, safari]
 
38
  - Python (或Python3) version:
39
 
40
  ### 其他
41
+ 补充说明
.github/ISSUE_TEMPLATE/report-server.md ADDED
@@ -0,0 +1,38 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ name: Report Server
3
+ about: 报告在远程服务器上部署时的问题或错误
4
+ title: "[远程部署] 简短的错误描述"
5
+ labels: question, server deployment
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ > 感谢提交 issue! 请尽可能完整填写以下信息,帮助我们更好地定位问题~
11
+ > 请务必先查看 README 中是否已经对您的问题做出了解答。如果没有,请检索issue,查看有没有相同或类似的问题。如果您确信这是一个前人没有遇到的问题,欢迎提交该issue!注意,请编辑issue标题栏“简短的错误描述”部分,也请替换我们的issue模板中的原文。
12
+
13
+ ### 错误描述
14
+ 请简明描述该错误。
15
+
16
+ ### 复现操作
17
+ 描述出现错误的操作步骤。
18
+
19
+ ### 错误截图
20
+ 如果可以,请提供错误的截图,如部署的网页截图与控制台错误报告的截图。
21
+
22
+ ### 终端(控制台)中的错误报告
23
+ 如果可以,请复制终端中的主要错误报告。
24
+
25
+ ```console
26
+ (请使用错误报告替换本行)
27
+ ```
28
+
29
+ ### 运行环境
30
+ **请填写以下列表:**
31
+
32
+ - OS: [e.g. Linux Ubuntu]
33
+ - Docker version:
34
+ - Gradio version:
35
+ - Python (或Python3) version:
36
+
37
+ ### 其他
38
+ 补充说明