Skip to content

Commit 31b971c

Browse files
Svetlana KarsliogluZainRizvi
Svetlana Karslioglu
andauthored
Add issue templates (#2228)
* Add GH issue template * Add the feature and bug report templates Co-authored-by: Zain Rizvi <ZainRizvi@users.noreply.github.com>
1 parent 3ba83fa commit 31b971c

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: 🐛 Bug Report
2+
description: Create a tutorial bug report
3+
title: "[BUG] - <title>"
4+
labels: [
5+
"bug"
6+
]
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: >
12+
#### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/pytorch/tutorials/issues?q=is%3Aissue+sort%3Acreated-desc+).
13+
- type: textarea
14+
attributes:
15+
label: Describe the bug
16+
description: |
17+
**Link to the tutorial on the website:** <Add link>
18+
placeholder: |
19+
Provide a detailed description of the issue with code samples if relevant
20+
```python
21+
22+
# Sample code to reproduce the problem if relevant
23+
```
24+
25+
**Expected Result:** (Describe what you were expecting to see)
26+
27+
28+
**Actual Result:** (Describe the result)
29+
30+
```
31+
The error message you got, with the full traceback.
32+
```
33+
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: Describe your environment
39+
description: |
40+
**Describe the environment you encountered the bug in:**
41+
placeholder: |
42+
* Platform (i.e macOS, Linux, Google Colab):
43+
* CUDA (yes/no, version?):
44+
* PyTorch version (run `python -c "import torch; print(torch.__version__)"`):
45+
46+
validations:
47+
required: true
48+
- type: markdown
49+
attributes:
50+
value: >
51+
Thanks for contributing 🎉!
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: 🚀 Feature request
2+
description: Submit a proposal for a new PyTorch tutorial or improvement of an existing tutorial
3+
title: "💡 [REQUEST] - <title>"
4+
labels: [
5+
"feature"
6+
]
7+
8+
body:
9+
- type: textarea
10+
attributes:
11+
label: 🚀 Descirbe the improvement or the new tutorial
12+
description: |
13+
**Describe the improvement**
14+
placeholder: |
15+
Explain why this improvement or new tutorial is important. For example, *"This tutorial will help users to better understand feature X of PyTorch."* If there is a tutorial that you propose to replace, add here. If this is related to another GitHub issue, add a link here.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Existing tutorials on this topic
21+
description: |
22+
**Add a list of existing tutorials on the same topic.**
23+
placeholder: |
24+
List tutorials that already explain this functionality if exist. On pytorch.org or elsewhere.
25+
* Link
26+
* Link
27+
- type: textarea
28+
attributes:
29+
label: Additional context
30+
description: |
31+
**Add additional context**
32+
placeholder: |
33+
Add any other context or screenshots about the feature request.
34+
- type: markdown
35+
attributes:
36+
value: >
37+
Thanks for contributing 🎉!

0 commit comments

Comments
 (0)