-
Notifications
You must be signed in to change notification settings - Fork 263
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create a issue template for bugs (#912)
* borrowing from pymatgen a bug tracking template * rename * update bug report yaml * inspired from QUACC add in misc intake form
- Loading branch information
Showing
2 changed files
with
90 additions
and
0 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,80 @@ | ||
name: Report a Bug | ||
description: FAIR-Chem bug report | ||
labels: bug | ||
body: | ||
- type: input | ||
id: python-version | ||
attributes: | ||
label: Python version | ||
description: Use `python --version` to get Python version | ||
placeholder: ex. Python 3.11.5 | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: fairchem-version | ||
attributes: | ||
label: fairchem-core version | ||
description: Use `pip show fairchem-core | grep Version` to get fairchem-core version | ||
placeholder: ex. 1.2.1 | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: torch-version | ||
attributes: | ||
label: pytorch version | ||
description: Use `pip show torch | grep Version` to get pytorch version | ||
placeholder: ex. 2.4.0 | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: cuda-version | ||
attributes: | ||
label: cuda version | ||
description: Use `python -c 'import torch; cuda=torch.cuda.is_available(); print(cuda,torch.version.cuda if cuda else None);'` to get cuda version | ||
placeholder: ex. 12.1 | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: os | ||
attributes: | ||
label: Operating system version | ||
placeholder: ex. Ubuntu 22.04 LTS | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: code-snippet | ||
attributes: | ||
label: Minimal example | ||
description: Please provide a minimal code snippet to reproduce this bug. | ||
render: Python | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: current-behavior | ||
attributes: | ||
label: Current behavior | ||
description: What behavior do you see? | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: expected-behavior | ||
attributes: | ||
label: Expected Behavior | ||
description: What did you expect to see? | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: files | ||
attributes: | ||
label: Relevant files to reproduce this bug | ||
description: Please upload relevant files to help reproduce this bug, or logs if helpful. | ||
validations: | ||
required: false |
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,10 @@ | ||
name: Other | ||
description: A report is not a bug exactly | ||
|
||
body: | ||
- type: textarea | ||
attributes: | ||
label: What would you like to report? | ||
description: A clear and concise description of what you would like to report. | ||
validations: | ||
required: true |