From 8748d866f0846c1ad9f0aa036b247d813877472b Mon Sep 17 00:00:00 2001 From: Tom Smith Date: Thu, 7 Mar 2024 21:01:55 +0000 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 25 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 ++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..7f4018b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,25 @@ +--- +name: Bug report +about: Create a bug report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior. If possible, include example data. At the very least, explain what the input data was and provide the `umi_tools` command used. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Environment** + - OS: [e.g. iOS] + - UMI-tools version [e.g. 1.1.3] + - How was UMI-tools installed (e.g pip/conda etc) + +**Additional context** +Add any other context about the problem here. Was UMI-tools being run within another pipeline, etc. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..7dd3f7b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is this something you propose to solve/implement, or is this a request?** + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered or have implemented. What are the limitations of this approach compared to what you are requesting/implementing? + +**Additional context** +Add any other context or screenshots about the feature request here.