Skip to content

Commit

Permalink
chore: update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
kmnhan committed Apr 15, 2024
1 parent 5e373f4 commit 5dfb250
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 40 deletions.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Bug report
description: Create a report to help us improve
labels: [bug]
assignees: [kmnhan]
body:
- type: textarea
id: what-happened
attributes:
label: What happened?
description: |
Thanks for reporting a bug! Please describe what you were trying to get done.
Tell us what happened, what went wrong.
validations:
required: true

- type: textarea
id: what-did-you-expect-to-happen
attributes:
label: What did you expect to happen?
description: |
A clear and concise description of what you expected to happen.
validations:
required: false

- type: textarea
id: sample-code
attributes:
label: Minimal Complete Verifiable Example
description: |
Minimal, self-contained copy-pastable example that demonstrates the issue. This will be automatically formatted into code, so no need for markdown backticks.
render: Python

- type: checkboxes
id: mvce-checkboxes
attributes:
label: MVCE confirmation
description: |
Please confirm that the bug report is in an excellent state, so we can understand & fix it quickly & efficiently. For more details, check out:
- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
- [Craft Minimal Bug Reports](https://matthewrocklin.com/minimal-bug-reports)
options:
- label: Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue.
- label: Complete example — the example is self-contained, including all data and the text of any traceback.
- label: Verifiable example — the example copy & pastes into an IPython prompt, returning the result.
- label: New issue — a search of GitHub Issues suggests this is not a duplicate.
- label: Recent environment — the issue occurs with the latest version of erlab and its dependencies.

- type: textarea
id: additional-context
attributes:
label: Additional context
description: |
Add any other context about the problem here, including screenshots or a list of packages and versions installed if relevant.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Feature Request
description: Suggest an idea for this project
labels: [enhancement]
assignees: [kmnhan]
body:
- type: textarea
id: description
attributes:
label: Is your feature request related to a problem? Please describe.
description: |
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: |
A clear and concise description of what you want to happen.
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: |
A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional context
description: |
Add any other context or screenshots about the feature request here.
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 5dfb250

Please sign in to comment.