diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..91104f90 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 13406fa1..02b098e4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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.