Skip to content

Commit

Permalink
Update issue templates to SIRIUS version
Browse files Browse the repository at this point in the history
  • Loading branch information
mfleisch authored Sep 5, 2024
1 parent 6082614 commit 37d1c72
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 22 deletions.
31 changes: 17 additions & 14 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] - '...'"
title: "[BUG] - descriptive title..."
labels: probable bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.
**Bug description**
>A concise description of the bug. Include information on what is happening, when it occurs (every time, occasionally, or randomly), and any error messages or unexpected behavior.
**To Reproduce**
Steps to reproduce the behavior:
**Expected behavior**
> A clear and concise description of what you expected to happen.
**Steps To Reproduce**
> List the steps needed to reproduce the bug. Be as detailed as possible (e.g. include all parameters) to help the development team replicate the issue.
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots and Log Files**
>Please upload screenshots of any errors and include log output or console output. Log can be copied from the graphical user interface using the log button.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Example data**
> Include any additional information that might help the development team to reproduce the bug, in particular relevant project files or datasets, that demonstrate the problem you are reporting.
**System Info (please complete the following information):**
- OS and Version: [e.g. Windows 11]
- SIRIUS Version [e.g. 6.0.5]
- Hardware [e.g. CPU, RAM]
- **OS and Version:** [e.g. Windows 11]
- **SIRIUS Version** [e.g. 6.0.5]
- **Hardware** [Hardware specifications, e.g. CPU, RAM]

**Additional context**
Add any other context about the problem here.
**Workarounds**
> If you have found any temporary solutions or workarounds to the bug, please describe them here.
19 changes: 11 additions & 8 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,17 @@ 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 [...]
Feature Description:
>Provide a concise description of the feature you are requesting. Be as specific as possible about what the feature should do and how it will improve the current functionality of SIRIUS.
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Use Case / Problem Description**
>Is your feature request related to a problem or a specific use case? Explain how this feature will be used in your workflow or research. Provide examples to illustrate the importance and utility of the feature.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Benefits**
>List the benefits that the requested feature will bring to the users. Consider aspects such as time savings, improved accuracy, and enhanced functionality.
**Additional context**
Add any other context or screenshots about the feature request here.
**Related Issues**
>Does this new feature address or improve any existing issues?
**Additional Information**
> Include any additional information that might be relevant to the feature request. This can include references to scientific literature, links to similar features in other software, screenshots or mockups that could help illustrate the feature, or feedback from other users.

0 comments on commit 37d1c72

Please sign in to comment.