Skip to content

Commit

Permalink
Convert issue report templates to forms (scverse#2503)
Browse files Browse the repository at this point in the history
Co-authored-by: Lukas Heumos <[email protected]>
  • Loading branch information
flying-sheep and Zethson authored Jun 7, 2023
1 parent 8d9b772 commit 9cab8cf
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 64 deletions.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Bug report
description: Scanpy doesn’t do what it should? Please help us fix it!
#title: ...
labels: [bug]
#assignees: []
body:
- type: checkboxes
id: terms
attributes:
label: Please make sure these conditions are met
# description: ...
options:
- label: I have checked that this issue has not already been reported.
required: true
- label: I have confirmed this bug exists on the latest version of scanpy.
required: true
- label: (optional) I have confirmed this bug exists on the master branch of scanpy.
required: false
- type: markdown
attributes:
value: |
**Note**: Please read [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to provide the necessary information for us to reproduce your bug.
- type: textarea
id: description
attributes:
label: What happened?
description: Describe what you tried to do, and what happened instead.
validations:
required: true
- type: textarea
id: code
attributes:
label: Minimal code sample
description: (that we can copy&paste without having any data)
render: python
validations:
required: true
- type: textarea
id: traceback
attributes:
label: Error output
description: Produced by the code above. Leave empty if the issue is unexpected behavior instead of an error.
render: pytb
validations:
required: false
- type: textarea
id: versions
attributes:
label: Versions
description: Paste the output of scanpy.logging.print_versions() leaving a blank line after the details tag
render: markdown
value: |
<details>
</details>
validations:
required: true
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/enhancement-request.md

This file was deleted.

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Enhancement request
description: Anything you’d like to see in scanpy?
#title: ...
labels: [enhancement]
#assignees: []
body:
- type: dropdown
id: kind
attributes:
label: What kind of feature would you like to request?
options:
- 'Additional function parameters / changed functionality / changed defaults?'
- 'New analysis tool: A simple analysis tool you have been using and are missing in `sc.tools`?'
- 'New plotting function: A kind of plot you would like to seein `sc.pl`?'
- 'Other?'
validations:
required: true
- type: textarea
id: description
attributes:
label: Please describe your wishes
validations:
required: true
13 changes: 0 additions & 13 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

0 comments on commit 9cab8cf

Please sign in to comment.