Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Old-Shatterhand authored Mar 18, 2024
1 parent df25326 commit ab76dd9
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Create a bug report to help us improve DataSAIL
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Minimal example to reproduce the behavior. Please provide the call to DataSAIL or to one of its functions with the required data (if possible) to reproduce the bug.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Environment (please complete the following information):**
- OS: [e.g. MacOS, Linux, Win-64]
- DataSAIL Version [e.g. datasail v0.2.2 or datasail-lite v1.0.0]
- Python Version [e.g. Py3.10]
- other useful information about the system, e.g. usage of a WSL or docker

**Additional context**
Add any other context about the problem here. This can be everything not yet mentioned that you may find helpful for us to tackle the issue.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea to improve DataSAIL
title: ''
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. This can be related to another issue.

**Describe the solution you'd like**
A clear and concise description of what you want to happen. Potentially also with implementation ideas such as algorithms or data structures (if appropriate).

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/question-help-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Question/Help request
about: Ask for help or clarification about the behaviour of DataSAIL.
title: ''
labels: question
assignees: ''

---

**What is your input?**
Describe how you use DataSAIL using code/data and examples.

**What do you observe?**
Which outcome of DataSAIL do you encounter?

**What do you expect?**
Which outcome of DataSAIL do you expect? Describe how the outcome of DataSAIL confuses you.

**Environment (please complete the following information):**
- OS: [e.g. MacOS, Linux, Win-64]
- DataSAIL Version [e.g. datasail v0.2.2 or datasail-lite v1.0.0]
- Python Version [e.g. Py3.10]
- other useful information about the system, e.g. usage of a WSL or docker

**Additional context**
Add any other context or screenshots about the feature request here.

0 comments on commit ab76dd9

Please sign in to comment.