Skip to content

Commit 705aa92

Browse files
author
xusenlin
committed
Update issue template
1 parent 0edca1b commit 705aa92

File tree

3 files changed

+150
-61
lines changed

3 files changed

+150
-61
lines changed

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE_ZH.yml

-61
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: 🐞 Bug
2+
description: 提交错误报告 | File a bug/issue
3+
4+
body:
5+
- type: checkboxes
6+
id: mustchecks
7+
attributes:
8+
label: 提交前必须检查以下项目 | The following items must be checked before submission
9+
description: |
10+
请在提问前检查以下项目,善用搜索功能查找与自己问题相关的issue。
11+
Please check the following items before asking a question, and make good use of the search function to find issues related to your question.
12+
options:
13+
- label: 请确保使用的是仓库最新代码(git pull),一些问题已被解决和修复。 | Make sure you are using the latest code from the repository (git pull), some issues have already been addressed and fixed.
14+
required: true
15+
- label: 我已阅读[项目文档](https://github.com/xusenlinzy/api-for-open-llm/blob/master/README.md)和[FAQ章节](https://github.com/xusenlinzy/api-for-open-llm/blob/master/docs/FAQ.md)并且已在Issue中对问题进行了搜索,没有找到相似问题和解决方案 | I have searched the existing issues / discussions
16+
required: true
17+
- type: dropdown
18+
id: question-type
19+
attributes:
20+
label: 问题类型 | Type of problem
21+
description: 请选择最符合的问题类型 | Please select the type of question that best matches
22+
options:
23+
- 安装环境 | Installation environment
24+
- 启动命令 | Startup command
25+
- 模型推理和部署 | Model inference and deployment
26+
- 效果问题 | Effectiveness issues
27+
- 其他问题 | Other issues
28+
- type: dropdown
29+
id: operating-system
30+
attributes:
31+
label: 操作系统 | Operating system
32+
description: 请提供操作系统类型 | Please provide the type of operating system
33+
options:
34+
- Windows
35+
- macOS
36+
- Linux
37+
- type: textarea
38+
id: question-detailed
39+
attributes:
40+
label: 详细描述问题 | Detailed description of the problem
41+
description: |
42+
请尽量具体地描述遇到的问题,**代码程序类问题务必给出完整运行命令**,这将有助于快速定位问题所在。
43+
Please be as specific as possible in describing the problem encountered, **Be sure to give the full run command for code program type problems**, this will help to quickly pinpoint the problem.
44+
value: |
45+
```
46+
# 请在此处粘贴运行代码(如没有可删除该代码块)
47+
# Paste the runtime code here (delete the code block if you don't have it)
48+
```
49+
- type: textarea
50+
id: dependencies
51+
attributes:
52+
label: Dependencies
53+
description: |
54+
请提供transformers, peft, torch等常规依赖库的版本:`pip list | grep -E 'transformers|peft|torch'`
55+
Please provide versions of the usual dependencies such as transformers, peft, torch, etc.: `pip list | grep -E 'transformers|peft|torch' `
56+
value: |
57+
```
58+
# 请在此处粘贴依赖情况
59+
# Please paste the dependencies here
60+
```
61+
- type: textarea
62+
id: logs
63+
attributes:
64+
label: 运行日志或截图 | Runtime logs or screenshots
65+
description: |
66+
请优先提供文本形式的log(过长内容请上传文件),粘贴内容放在markdown代码块。或者提供截图形式的运行记录。
67+
Running log or screenshot please prefer to provide the log in text form (please upload the file if it is too long) and paste the content in markdown code block. Or provide the run log in the form of screenshot.
68+
value: |
69+
```
70+
# 请在此处粘贴运行日志
71+
# Please paste the run log here
72+
```
+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: "💡 Feature Request"
2+
description: 创建新功能请求 | Create a new ticket for a new feature request
3+
title: "💡 [REQUEST] - <title>"
4+
labels: [
5+
"question"
6+
]
7+
body:
8+
- type: input
9+
id: start_date
10+
attributes:
11+
label: "起始日期 | Start Date"
12+
description: |
13+
起始开发日期
14+
Start of development
15+
placeholder: "month/day/year"
16+
validations:
17+
required: false
18+
- type: textarea
19+
id: implementation_pr
20+
attributes:
21+
label: "实现PR | Implementation PR"
22+
description: |
23+
实现该功能的Pull request
24+
Pull request used
25+
placeholder: "#Pull Request ID"
26+
validations:
27+
required: false
28+
- type: textarea
29+
id: reference_issues
30+
attributes:
31+
label: "相关Issues | Reference Issues"
32+
description: |
33+
与该功能相关的issues
34+
Common issues
35+
placeholder: "#Issues IDs"
36+
validations:
37+
required: false
38+
- type: textarea
39+
id: summary
40+
attributes:
41+
label: "摘要 | Summary"
42+
description: |
43+
简要描述新功能的特点
44+
Provide a brief explanation of the feature
45+
placeholder: |
46+
Describe in a few lines your feature request
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: basic_example
51+
attributes:
52+
label: "基本示例 | Basic Example"
53+
description: Indicate here some basic examples of your feature.
54+
placeholder: A few specific words about your feature request.
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: drawbacks
59+
attributes:
60+
label: "缺陷 | Drawbacks"
61+
description: |
62+
该新功能有哪些缺陷/可能造成哪些影响?
63+
What are the drawbacks/impacts of your feature request ?
64+
placeholder: |
65+
Identify the drawbacks and impacts while being neutral on your feature request
66+
validations:
67+
required: true
68+
- type: textarea
69+
id: unresolved_question
70+
attributes:
71+
label: "未解决问题 | Unresolved questions"
72+
description: |
73+
有哪些尚未解决的问题?
74+
What questions still remain unresolved ?
75+
placeholder: |
76+
Identify any unresolved issues.
77+
validations:
78+
required: false

0 commit comments

Comments
 (0)