Skip to content

Commit

Permalink
chore(.github): update issue templates (#124)
Browse files Browse the repository at this point in the history
  • Loading branch information
XuehaiPan committed Dec 3, 2022
1 parent 96d78c4 commit 91c4554
Show file tree
Hide file tree
Showing 8 changed files with 200 additions and 113 deletions.
119 changes: 119 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
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.
65 changes: 0 additions & 65 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
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.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
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.
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/questions.yml
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
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/questions_help_support.md

This file was deleted.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "torchopt"
description = "A Jax-style optimizer for PyTorch."
description = "An efficient library for differentiable optimization for PyTorch."
readme = "README.md"
# Change this if wheels for `torch` is available
# Search "requires-python" and update all corresponding items
Expand Down

0 comments on commit 91c4554

Please sign in to comment.