Skip to content

Commit

Permalink
Add bug report template
Browse files Browse the repository at this point in the history
  • Loading branch information
patel-zeel committed Oct 28, 2023
1 parent 732bb7a commit 80a9320
Showing 1 changed file with 92 additions and 0 deletions.
92 changes: 92 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# This template is inspired from https://github.com/metaopt/optree

name: 🐛 Bug Report
description: File an issue about a bug.
title: "[BUG] "
labels: [bug]
# assignees: [patel-zeel]
body:
- type: markdown
attributes:
value: |
Please do your best to make the issue as easy to act on as possible.
- 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 [this post from stackoverflow](https://stackoverflow.com/help/minimal-reproducible-example) on creating a minimal, reproducible example
required: true
- label: I have searched the [Issue Tracker](https://github.com/sustainability-lab/ASTRA/issues) that this hasn't already been reported. (comment there if it has.)
required: true

- type: input
id: version
attributes:
label: What version of ASTRA are you using?
description: Run command `python3 -c 'print(__import__("astra").__version__)'` in your shell and paste the output here.
placeholder: E.g., 0.5.0
validations:
required: true

- type: input
id: version
attributes:
label: What Python version are you using?
description: Run command `python -V` in your shell and paste the output here.
placeholder: E.g., Python 3.11.5
validations:
required: true

- type: textarea
id: description
attributes:
label: Problem description
description: >-
Provide a short description, state the expected behavior, what actually happens and any useful commands / output.
validations:
required: true

- type: textarea
id: code
attributes:
label: Reproducible example code
description: >-
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.
value: |
The Python snippets:
```python
```
validations:
required: true

- type: textarea
id: traceback
attributes:
label: Traceback
description: Put the Python traceback information here.
placeholder: |
Traceback (most recent call last):
File ...
render: pytb

# - type: textarea
# id: expected
# attributes:
# label: Expected behavior
# description: Provide a clear and concise description of what you expected to happen.

- type: textarea
id: additional-context
attributes:
label: Additional context
description: >-
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.

0 comments on commit 80a9320

Please sign in to comment.