-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Add issue templates #2228
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
46cf54c
Add GH issue template
152ae37
Add the feature and bug report templates
b4878ae
Merge branch 'main' into add-issue-template-2
f31a0db
Update bug-report.yml
86ca242
Update feature-request.yml
ea13790
Update feature-request.yml
023b539
Update bug-report.yml
578dcbd
Update bug-report.yml
003ffcd
Update feature-request.yml
7a176c1
Update feature-request.yml
fd289a4
Merge branch 'main' into add-issue-template-2
d416f27
Update .github/ISSUE_TEMPLATE/bug-report.yml
8cbb100
Merge branch 'main' into add-issue-template-2
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 🎉! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
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 🎉! |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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.