-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(.github): update issue templates (#124)
- Loading branch information
Showing
8 changed files
with
200 additions
and
113 deletions.
There are no files selected for viewing
This file contains 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,119 @@ | ||
name: 🐛 Bug Report | ||
description: File an issue about a bug. | ||
title: "[BUG] " | ||
labels: [bug] | ||
assignees: [Benjamin-eecs] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Please do your best to make the issue as easy to act on as possible, and only submit here if there is clearly a problem with TorchOpt (ask in [Discussions](https://github.com/metaopt/torchopt/discussions) first if unsure). | ||
- type: checkboxes | ||
id: steps | ||
attributes: | ||
label: Required prerequisites | ||
description: Make sure you've completed the following steps before submitting your issue -- thank you! | ||
options: | ||
- label: I have read the documentation <https://torchopt.readthedocs.io>. | ||
required: true | ||
- label: I have searched the [Issue Tracker](https://github.com/metaopt/torchopt/issues) and [Discussions](https://github.com/metaopt/torchopt/discussions) that this hasn't already been reported. (+1 or comment there if it has.) | ||
required: true | ||
- label: Consider asking first in a [Discussion](https://github.com/metaopt/torchopt/discussions/new). | ||
required: false | ||
|
||
- type: input | ||
id: version | ||
attributes: | ||
label: | | ||
What version of TorchOpt are you using? | ||
value: | | ||
python3 -m pip show torchopt | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: system-info | ||
attributes: | ||
label: System information | ||
value: | | ||
Describe the characteristic of your environment: | ||
- Describe how the library was installed (pip, conda, source, ...) | ||
- Python version | ||
- Versions of any other relevant libraries | ||
```python | ||
import sys, torch, functorch, torchopt | ||
print(sys.version, sys.platform) | ||
print(torchopt.__version__, torch.__version__, functorch.__version__) | ||
``` | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Problem description | ||
placeholder: | | ||
Provide a short description, state the expected behavior and what actually happens. Include | ||
relevant information like what version of TorchOpt you are using, what system you are on, | ||
and any useful commands / output. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: code | ||
attributes: | ||
label: Reproducible example code | ||
value: | | ||
<!-- The code should be minimal, have minimal external dependencies, and isolate the | ||
functions that cause breakage. Submit matched and complete snippets that can be easily | ||
run to diagnose the issue. --> | ||
The Python snippets: | ||
```python | ||
``` | ||
Run the snippets with the following commands: | ||
```bash | ||
``` | ||
Extra dependencies: | ||
```text | ||
``` | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: traceback | ||
attributes: | ||
label: Traceback | ||
placeholder: | | ||
Put the Python traceback information here. | ||
Traceback (most recent call last): | ||
File ... | ||
render: pytb | ||
|
||
- type: textarea | ||
id: expected | ||
attributes: | ||
label: Expected behavior | ||
placeholder: | | ||
Provide a clear and concise description of what you expected to happen. | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
placeholder: | | ||
Add any other context about the problem here. Screenshots may also be helpful. | ||
If you know or suspect the reason for this bug, paste the code lines and suggest modifications. |
This file was deleted.
Oops, something went wrong.
This file contains 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,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: 💬 Start a discussion | ||
url: https://github.com/metaopt/torchopt/discussions/new | ||
about: Please ask and answer questions here if unsure. |
This file contains 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,48 @@ | ||
name: ✨ Feature Request | ||
description: Suggest an idea for this project. | ||
title: "[Feature Request] " | ||
labels: [enhancement] | ||
assignees: [Benjamin-eecs] | ||
body: | ||
- type: checkboxes | ||
id: steps | ||
attributes: | ||
label: Required prerequisites | ||
description: Make sure you've completed the following steps before submitting your issue -- thank you! | ||
options: | ||
- label: I have searched the [Issue Tracker](https://github.com/metaopt/torchopt/issues) and [Discussions](https://github.com/metaopt/torchopt/discussions) that this hasn't already been reported. (+1 or comment there if it has.) | ||
required: true | ||
- label: Consider asking first in a [Discussion](https://github.com/metaopt/torchopt/discussions/new). | ||
required: false | ||
|
||
- type: textarea | ||
id: motivation | ||
attributes: | ||
label: Motivation | ||
value: | | ||
<!-- Please outline the motivation for the proposal. | ||
Is your feature request related to a problem? E.g., "I'm always frustrated when [...]". | ||
If this is related to another issue, please link here too. --> | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Solution | ||
placeholder: | | ||
Provide a clear and concise description of what you want to happen. | ||
- type: textarea | ||
id: alternatives | ||
attributes: | ||
label: Alternatives | ||
placeholder: | | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
placeholder: | | ||
Add any other context about the problem here. Screenshots may also be helpful. |
This file was deleted.
Oops, something went wrong.
This file contains 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,27 @@ | ||
name: 🤔 Questions / Help / Support | ||
description: Do you need support? | ||
title: "[Question] " | ||
labels: [question] | ||
assignees: [Benjamin-eecs] | ||
body: | ||
- type: checkboxes | ||
id: steps | ||
attributes: | ||
label: Required prerequisites | ||
description: Make sure you've completed the following steps before submitting your issue -- thank you! | ||
options: | ||
- label: I have read the documentation <https://torchopt.readthedocs.io>. | ||
required: true | ||
- label: I have searched the [Issue Tracker](https://github.com/metaopt/torchopt/issues) and [Discussions](https://github.com/metaopt/torchopt/discussions) that this hasn't already been reported. (+1 or comment there if it has.) | ||
required: true | ||
- label: Consider asking first in a [Discussion](https://github.com/metaopt/torchopt/discussions/new). | ||
required: false | ||
|
||
- type: textarea | ||
id: questions | ||
attributes: | ||
label: Questions | ||
placeholder: | | ||
Describe your questions with relevant resources such as snippets, links, images, etc. | ||
validations: | ||
required: true |
This file was deleted.
Oops, something went wrong.
This file contains 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