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

Add GitHub Issue Templates #3528

Merged
merged 6 commits into from
Dec 20, 2023
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
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Report a Bug
description: Use this template to report a Pymatgen-related 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: pmg-version
attributes:
label: Pymatgen version
description: Use `pip show pymatgen | grep Version` to get Pymatgen version
placeholder: ex. 2023.12.18
validations:
required: true

- type: input
id: os
attributes:
label: Operating system version
placeholder: ex. Ubuntu 22.04 LTS
validations:
required: false

- type: textarea
id: current-behavior
attributes:
label: Current behavior
description: What bad behavior do you see?
render: python
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: 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: 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
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Feature Reqest
description: Use this template to request a new feature
body:
- type: textarea
id: feature
attributes:
label: Feature Requested
description: Specify the feature and provide examples or use cases.
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Share your thoughts on how the feature could be implemented.
placeholder: Implement a new method that ...
validations:
required: true

- type: textarea
id: relevant
attributes:
label: Relevant Information
description: Additional context or links for understanding or implementing the feature.
placeholder: Use cases, related discussions, relevant literature, ...
validations:
required: false