diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..164b814 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: ckmah + +--- + +**Describe the bug** +A clear and concise description of what the bug is. Please note what dataset you are using (tutorial, public data, your own, etc.). + +**Steps to reproduce** +Your script/notebook including the command and error that is produced. + +**Data Inspection** (recommended) +A short preview of some data to help diagnose. + +For example, show the head of cell, nuclei, and transcripts DataFrames. + +```{python} +sdata[cells_key].head() +# Output here +``` + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem.