Skip to content

Commit

Permalink
Add issue templates (#632)
Browse files Browse the repository at this point in the history
* Add issue templates

* adds support request template

---------

Co-authored-by: Tom Smith <tomsmith@tss38-im.local>
  • Loading branch information
TomSmithCGAT and Tom Smith authored Jun 11, 2024
1 parent 3bd6a38 commit 10c6495
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/support_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Support request
about: Help with running UMI-tools
title: ''
labels: ''
assignees: ''

---
:warning: :warning: :warning:
**Often you can get help more quickly from existing online material. Before you raise an issue to request help with running UMI-tools, please refer to:**

- [Frequently asked questions](https://umi-tools.readthedocs.io/en/latest/faq.html)
- [Documentation](https://umi-tools.readthedocs.io/en/latest/)
- Search within the existing [open/closed issues](https://github.com/CGATOxford/UMI-tools/issues?q=is%3Aissue)
- [Biostars](https://www.biostars.org/post/search/?query=umi_tools)
- Web search engine


If the above links don't provide the information/advice required, please consider posting on [Biostars](https://www.biostars.org/new/post/). You're likely to get a response just as quick and your question will be visible to a larger community who can help and/or benefit from the post

If you believe the support request is best made via a github issue, please delete this text and go ahead :smile:



0 comments on commit 10c6495

Please sign in to comment.