Skip to content

Commit b7dfdb3

Browse files
XuehaiPanXuehaiPan
authored
[Misc] Add GitHub issue templates (#1057)
1 parent fb8b3af commit b7dfdb3

File tree

4 files changed

+183
-0
lines changed

4 files changed

+183
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
name: 🐛 Bug Report
2+
description: File an issue about a bug.
3+
title: "[BUG] "
4+
labels: [bug]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >-
10+
Please do your best to make the issue as easy to act on as possible,
11+
and only submit here if there is clearly a problem with TileLang.
12+
13+
- type: checkboxes
14+
id: steps
15+
attributes:
16+
label: Required prerequisites
17+
description: Make sure you've completed the following steps before submitting your issue -- thank you!
18+
options:
19+
- label: I have read the documentation <https://tilelang.com>.
20+
required: true
21+
- label: >-
22+
I have searched the [Issue Tracker](https://github.com/tile-ai/tilelang/issues)
23+
that this hasn't already been reported. (comment there if it has.)
24+
required: true
25+
26+
- type: input
27+
id: version
28+
attributes:
29+
label: What version of TileLang are you using?
30+
description: >-
31+
Run command `python3 -c 'print(__import__("tilelang").__version__)'` in your shell
32+
and paste the output here.
33+
placeholder: E.g., 0.1.5
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: system-info
39+
attributes:
40+
label: System information
41+
description: |
42+
Describe the characteristic of your environment:
43+
44+
- Describe how the library was installed (pip, conda, source, ...)
45+
- Python version
46+
- Versions of any other relevant libraries
47+
48+
```python
49+
import sys, tilelang, torch
50+
print(sys.version, sys.platform)
51+
print(tilelang.__version__)
52+
print(torch.__version__)
53+
```
54+
55+
```bash
56+
python3 -m torch.utils.collect_env
57+
```
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: description
63+
attributes:
64+
label: Problem description
65+
description: >-
66+
Provide a short description, state the expected behavior and what actually happens. Include
67+
relevant information like what version of TileLang you are using, what system you are on, and
68+
any useful commands / output.
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
id: code
74+
attributes:
75+
label: Reproducible example code
76+
description: >-
77+
The code should be minimal, have minimal external dependencies, and isolate the functions
78+
that cause breakage. Submit matched and complete snippets that can be easily run to diagnose
79+
the issue.
80+
value: |
81+
The Python snippets:
82+
83+
```python
84+
85+
```
86+
validations:
87+
required: true
88+
89+
- type: textarea
90+
id: traceback
91+
attributes:
92+
label: Traceback
93+
description: Put the Python traceback information here.
94+
placeholder: |
95+
Traceback (most recent call last):
96+
File ...
97+
render: pytb
98+
99+
- type: textarea
100+
id: expected
101+
attributes:
102+
label: Expected behavior
103+
description: Provide a clear and concise description of what you expected to happen.
104+
105+
- type: textarea
106+
id: additional-context
107+
attributes:
108+
label: Additional context
109+
description: >-
110+
Add any other context about the problem here. Screenshots may also be helpful.
111+
112+
If you know or suspect the reason for this bug, paste the code lines and suggest modifications.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: ✨ Feature Request
2+
description: Suggest an idea for this project.
3+
title: "[Feature Request] "
4+
labels: [enhancement]
5+
body:
6+
- type: checkboxes
7+
id: steps
8+
attributes:
9+
label: Required prerequisites
10+
description: Make sure you've completed the following steps before submitting your issue -- thank you!
11+
options:
12+
- label: >-
13+
I have searched the [Issue Tracker](https://github.com/tile-ai/tilelang/issues)
14+
that this hasn't already been reported. (comment there if it has.)
15+
required: true
16+
17+
- type: textarea
18+
id: motivation
19+
attributes:
20+
label: Motivation
21+
description: Outline the motivation for the proposal.
22+
value: |
23+
<!-- Please outline the motivation for the proposal.
24+
Is your feature request related to a problem? E.g., "I'm always frustrated when [...]".
25+
If this is related to another issue, please link here too. -->
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: solution
31+
attributes:
32+
label: Solution
33+
description: Provide a clear and concise description of what you want to happen.
34+
35+
- type: textarea
36+
id: alternatives
37+
attributes:
38+
label: Alternatives
39+
description: A clear and concise description of any alternative solutions or features you've considered.
40+
41+
- type: textarea
42+
id: additional-context
43+
attributes:
44+
label: Additional context
45+
description: Add any other context about the problem here. Screenshots may also be helpful.

‎.github/ISSUE_TEMPLATE/questions.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: 🤔 Questions / Help / Support
2+
description: Do you need support?
3+
title: "[Question] "
4+
labels: [question]
5+
body:
6+
- type: checkboxes
7+
id: steps
8+
attributes:
9+
label: Required prerequisites
10+
description: Make sure you've completed the following steps before submitting your issue -- thank you!
11+
options:
12+
- label: I have read the documentation <https://tilelang.com>.
13+
required: true
14+
- label: >-
15+
I have searched the [Issue Tracker](https://github.com/tile-ai/tilelang/issues)
16+
that this hasn't already been reported. (comment there if it has.)
17+
required: true
18+
19+
- type: textarea
20+
id: questions
21+
attributes:
22+
label: Questions
23+
description: Describe your questions with relevant resources such as snippets, links, images, etc.
24+
validations:
25+
required: true

0 commit comments

Comments
 (0)