Skip to content

Commit

Permalink
Merge pull request #1 from ssciwr/add-issue-templates
Browse files Browse the repository at this point in the history
add issue templates
  • Loading branch information
MaHaWo authored Aug 19, 2024
2 parents ad77e04 + bce5ba3 commit b0fdc39
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATES/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Bug report
about: Create a 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: What command did you use, what code did you try to write? Add a minimal reproducing example if possible

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

**Screenshots or files**
If applicable, add screenshots/files to help explain your problem.

**machine/OS:
- OS: [e.g. iOS]


**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATES/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature Request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**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.

**Additional context**
Add any other context or screenshots about the feature request here.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATES/meta_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Meta-Feature Request
about: A meat-feature is a feature that decays naturally into multiple individual subfeatures that demand their own issues.
title: ''
labels: ''
assignees: ''

---

**What's the overarching idea and why is this additional feature necessary?**

**Describe into what individual steps/features your suggestion decays, and outline their basic ideas in one sentence each**


**Additional context**
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATES/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Question
about: Ask something about the functionality of the software
title: ''
labels: ''
assignees: ''

---

**What is your question?**
A clear and concise description of what you want to know.

**Background**
Describe what you want to do or what the relevant context of the question is.

**Have you considered any possible solutions? Why are they not adequate?**

0 comments on commit b0fdc39

Please sign in to comment.