Skip to content

Commit

Permalink
improved issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Meisrimel authored and Peter Meisrimel committed Oct 29, 2024
1 parent dffae5e commit 560b54b
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 19 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

Please make sure to check the issue tracker for existing issues!

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

**To Reproduce**
Steps to reproduce the behavior: Please provide a complete [minimal reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example).

Please provide any reproducing reproducers in **C**.
If your issue is related to *modelDescription.xml* parsing, kindly provide relevant entries in _cleartext_.

**Observed behavior**
Please describe observed issues and provide error messages and log output in _cleartext_.

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

Please make sure that the expected behavior corresponds to the FMI specification, see [specification documents](https://fmi-standard.org/).

**Versions**
- Version, e.g., _3.0.a4_, current master or a particular commit
- any other relevant information about your environment

**Additional context**
Add any other context about the problem here.
28 changes: 9 additions & 19 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,21 @@
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
labels: enhancement
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.
Please make sure to check the issue tracker for existing issues!

**To Reproduce**
Steps to reproduce the behavior: Please provide a complete [minimal reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example).
**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 [...]

Please provide any reproducing reproducers in **C**.
If your issue is related to *modelDescription.xml* parsing, kindly provide relevant entries in _cleartext_.
**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Observed behavior**
Please describe observed issues and provide error messages and log output in _cleartext_.

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

Please make sure that the expected behavior corresponds to the FMI specification, see [specification documents](https://fmi-standard.org/).

**Versions**
- Version, e.g., _3.0.a4_, current master or a particular commit
- any other relevant information about your environment
**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 about the problem here.
Add any other context or screenshots about the feature request here.

0 comments on commit 560b54b

Please sign in to comment.