Skip to content

Commit b7aeb4b

Browse files
author
dietvin
committed
Added issue templates
1 parent 8fa3306 commit b7aeb4b

5 files changed

Lines changed: 62 additions & 0 deletions

File tree

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug in Fishnet
4+
title: "[Bug]: "
5+
assignees: ''
6+
---
7+
8+
### Description
9+
Please provide a description of the bug. To make tracing an issue easier, provide the **command** you used, the **error message**, a **log file** (add the `--log-level error` flag to generate one) and a description of the **data** you used (DNA/RNA, R9/R10, etc). If possible also provide (a subset of) the POD5 and BAM data.
10+
11+
### Environment:
12+
- Fishnet version: [e.g., v0.4.1, v0.4.0]
13+
- OS: [e.g., Ubuntu24, Linux Mint 22.3, Windows]

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
blank_issues_enabled: false
2+
issue_templates:
3+
- name: "Bug Report"
4+
description: "Report a bug in Fishnet"
5+
title: "[Bug]: "
6+
labels: ["bug"]
7+
body: "./ISSUE_TEMPLATE/bug_report.md"
8+
- name: "Feature Request"
9+
description: "Suggest a new feature or improvement"
10+
title: "[Feature request]: "
11+
labels: ["enhancement"]
12+
body: "./ISSUE_TEMPLATE/feature_request.md"
13+
- name: "Documentation"
14+
description: "Suggest updates or additions to the documentation"
15+
title: "[Docs]: "
16+
labels: ["docs"]
17+
body: "./ISSUE_TEMPLATE/documentation.md"
18+
- name: "General Report"
19+
description: "Provide general feedback or inquiries"
20+
title: "[General]: "
21+
labels: ["general"]
22+
body: "./ISSUE_TEMPLATE/other.md"
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Documentation
3+
about: Suggest updates or additions to the documentation
4+
title: "[Docs]: "
5+
assignees: ''
6+
---
7+
8+
### Documentation update
9+
Please describe what part of the documentation should be updated or added. Why is this needed?
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or improvement
4+
title: "[Feature request]: "
5+
assignees: ''
6+
---
7+
8+
### What feature do you suggest for Fishnet?
9+
Please describe what feature you would like to have implemented in Fishnet? How should it be integrated? And what problem would this solve for you?

‎.github/ISSUE_TEMPLATE/other.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: General Report
3+
about: Provide general feedback or inquiries
4+
title: "[General]: "
5+
assignees: ''
6+
---
7+
8+
### Feedback or Inquiry
9+
If you have general feddback or an inquiry that doesn't fall into any of the given categories (`Bug Report`, `Feature Request` or `Documentation`), feel free to provide it here.

0 commit comments

Comments
 (0)