Skip to content

Add issue templates #2228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Mar 9, 2023
Merged
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 🐛 Bug Report
description: Create a tutorial bug report
title: "[BUG] - <title>"
labels: [
"bug"
]

body:
- type: markdown
attributes:
value: >
#### 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+).
- type: textarea
attributes:
label: Describe the bug
description: |
**Link to the tutorial on the website:** <Add link>
placeholder: |
Provide a detailed description of the issue with code samples if relevant
```python

# Sample code to reproduce the problem if relevant
```

**Expected Result:** (Describe what you were expecting to see)


**Actual Result:** (Describe the result)

```
The error message you got, with the full traceback.
```

validations:
required: true
- type: textarea
attributes:
label: Describe your environment
description: |
**Describe the environment you encountered the bug in:**
placeholder: |
* Platform (i.e macOS, Linux, Google Colab):
* CUDA (yes/no, version?):
* PyTorch version (run `python -c "import torch; print(torch.__version__)"`):

validations:
required: true
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: 🚀 Feature request
description: Submit a proposal for a new PyTorch tutorial or improvement of an existing tutorial
title: "💡 [REQUEST] - <title>"
labels: [
"feature"
]

body:
- type: textarea
attributes:
label: 🚀 Descirbe the improvement or the new tutorial
description: |
**Describe the improvement**
placeholder: |
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.
validations:
required: true
- type: textarea
attributes:
label: Existing tutorials on this topic
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the point of linking to existing tutorials?

Putting on my "contributor" hat, if I thought such tutorials already existed I'd prob not have bothered creating this new one

Copy link
Contributor Author

@svekars svekars Mar 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is if someone is proposing a tutorial on a topic that is already covered but might be outdated, uses old tech and so on. Like a better version of the existing one. If that's the case, we need to know so we can deprecate the old one which we often times forget.

description: |
**Add a list of existing tutorials on the same topic.**
placeholder: |
List tutorials that already explain this functionality if exist. On pytorch.org or elsewhere.
* Link
* Link
- type: textarea
attributes:
label: Additional context
description: |
**Add additional context**
placeholder: |
Add any other context or screenshots about the feature request.
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!