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

🐞 update issue templates #202

Merged
merged 14 commits into from
Aug 3, 2022
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema

name: 🐞 Bug report
description: Report any errors or problems with your example test case and/or full error messages.
labels: 'bug'
body:
- type: markdown
attributes:
value: |

**PLEASE READ THIS PARAGRAPH - this helps us identify the root cause and fix the issue:**

If you have a question about getting started or how a feature works, please report your question via our [Discussions Page](https://github.com/jacksund/simmate/discussions/categories/q-a). In many cases, an error message corresponds to using Simmate incorrectly rather than a bug. If you're unsure, stick to a discussion post. We'll then investigate any issues and open a bug report when necessary.

If you indeed have a bug, it helps to include things like the structure you used, the code, & input files while completing this form. For the code, try not to add long scripts if the error is only happening in one small part of it. Instead, try to generate your issue/error with as little code as possible or even using a illustrative example.

- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
attributes:
label: To Reproduce
description: Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example here.
placeholder: Insert code here

- type: textarea
attributes:
label: Error
description: Provide the full error message, including the full exception traceback.
placeholder: Copy complete stack trace and error message here, including log output if applicable.
value: |
``` python
Copy complete error message here.
```

- type: textarea
attributes:
label: Versions
description: "If you can access them, input your system info. HINT: you can find python and simmate versions with the command `conda list python` and `conda list simmate` while in your working env."
value: |
- Operating System:
- Python version:
- Simmate version:

- type: textarea
attributes:
label: Additional details
description: Add any other context about the problem here. If you have a suggested fix, you can include it here.

- type: markdown
attributes:
value: Thank you for using our software and helping us improve it!!
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema

name: ⭐ New feature request
description: Propose a new feature or an enhancement
labels: 'enhancement'
body:

- type: textarea
attributes:
label: Describe the desired feature
description: A clear and concise description of what new feature or behavior you would like to see

- type: textarea
attributes:
label: Current behavior and/or alternatives
description: A clear and concise description of any alternative solutions or features you have considered. How would you currently do this?

- type: textarea
attributes:
label: Example Use
description: Provide an example or description of how this would help users.

- type: textarea
attributes:
label: Additional context
description: Provide additional context about the use case here.

- type: markdown
attributes:
value: Thank you for using our software and helping us improve it!!
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Discussions page
url: https://github.com/jacksund/simmate/discussions
about: Ask for help and post about general questions & ideas.
- name: API documentation
url: https://jacksund.github.io/simmate/simmate.html
about: The complete documentation.
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Thank you for opening a pull request! Be sure to link this PR to any issues that it fixes.