Skip to content
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

Create a issue template for bugs #912

Merged
merged 6 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this isn't always applicable right? we allow this be blank?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right, this field is not required

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
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/misc.yaml
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