Skip to content

Commit 911a7a3

Browse files
[Doc] Add issue templates. (#435)
This PR provides issue templates for bug reports and feature requests. The templates can improve the efficiency to resolve the problem. --------- Signed-off-by: Yuchuan <[email protected]>
1 parent 0431333 commit 911a7a3

File tree

2 files changed

+78
-0
lines changed

2 files changed

+78
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help us reproduce and fix the bug
3+
title: "[Bug] "
4+
labels: ['Bug']
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Checklist
10+
options:
11+
- label: 1. I have searched related issues but cannot get the expected help.
12+
- label: 2. The bug has not been fixed in the latest version.
13+
- label: 3. I have filled all the required information below.
14+
- label: 4. The bug report is in English.
15+
- type: textarea
16+
attributes:
17+
label: Describe the bug
18+
description: A clear and concise description of what the bug is.
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: Reproduction
24+
description: |
25+
Please include a minimal code snippet to reproduce the behavior.
26+
placeholder: |
27+
A placeholder for the command.
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Environment
33+
description: |
34+
Please provide the version of XGrammar, the serving engine for llms, etc.
35+
placeholder: Environment here.
36+
validations:
37+
required: true
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: 🚀 Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature] "
4+
labels: ['Feature']
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Checklist
10+
options:
11+
- label: 1. I have searched related issues but cannot get the expected help.
12+
- label: 2. The latest version does not have this feature.
13+
- label: 3. I have filled all the required information below.
14+
- label: 4. The feature request is in English.
15+
- type: textarea
16+
attributes:
17+
label: requested feature
18+
description: |
19+
Please describe what's the requested feature.
20+
placeholder: |
21+
A clear and concise description of the requested feature.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Motivation
27+
description: |
28+
Please describe the motivation for the feature.
29+
placeholder: |
30+
A clear and concise description of the motivation for the feature.
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Alternatives
36+
description: |
37+
Please describe the alternatives you have considered.
38+
placeholder: |
39+
A clear and concise description of the alternatives you have considered, if any.
40+
validations:
41+
required: false

0 commit comments

Comments
 (0)