Skip to content

Commit

Permalink
GitHub Templates (#7275)
Browse files Browse the repository at this point in the history
  • Loading branch information
lochel committed Mar 6, 2021
1 parent 19d4643 commit f0c9a0b
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 25 deletions.
43 changes: 18 additions & 25 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,35 @@
---
name: Bug report
about: "Create a report to help us improve 🚀 "
title: Title
name: Bug Report
about: "Report a problem to help us improve 🚀"
title: ''
labels: ''
assignees: ''
---

### Description
A clear and concise description of what the bug is.

### Steps to reproduce
Steps to reproduce the behavior:
This could either be a list of actions or a Modelica script file (mos) that uses the [OpenModelica scripting API](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html).
<!--- A clear and concise description of what the bug is. -->

We really 💖 minimal working examples. With these reproducing a bug is straightforward and we can respond faster.
### Steps to Reproduce

Example minimalExample.mos:
```modelica
getVersion(); getErrorString();
loadModel(Modelica,{"4.0"}); getErrorString();
simulate(Modelica.Mechanics.MultiBody.Examples.Elementary.DoublePendulum); getErrorString();
```
Run with `$ omc minimalExample.mos` on your favourit unix-like shell or use CMD `>"C:\Program Files\OpenModelica1.17.0-dev-64bit\bin\omc.exe" minimalExample.mos`
<!--- This could either be a list of actions or a script file. -->

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

<!--- A clear and concise description of what you expected to happen. -->

### Screenshots
If applicable, add screenshots to help explain your problem.

### Additional files
You can add additional zip files via drag-and-drop, e.g. for your minimal working example.
Please use `File->Save Total` in OMEdit to save a model and all its dependencies to a single file.
<!--- If applicable, add screenshots to help explain your problem. -->

### Version and OS
- OpenModelica Version [run `omc --version` or check `Help->About OMEdit` from OMEdit]
- Versions of used Modelica libraries if applicable

<!--- Please complete the following information. -->

- OpenModelica Version: [e.g. `omc --version` or `Help->About OMEdit` from OMEdit]
- OS: [e.g. Windows 10, 64 bit]
- Versions of used Modelica libraries if applicable

### Additional Context

### Additional context
Add any other context about the problem here.
<!--- Add any other context about the problem here. -->
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/first_bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: First Bug Report
about: "Detailed guideline for your first bug report"
title: ''
labels: ''
assignees: ''
---

### Description
A clear and concise description of what the bug is.

### Steps to reproduce
Steps to reproduce the behavior:
This could either be a list of actions or a Modelica script file (mos) that uses the [OpenModelica scripting API](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html).

We really 💖 minimal working examples. With these reproducing a bug is straightforward and we can respond faster.

Example minimalExample.mos:
```modelica
getVersion(); getErrorString();
loadModel(Modelica,{"4.0"}); getErrorString();
simulate(Modelica.Mechanics.MultiBody.Examples.Elementary.DoublePendulum); getErrorString();
```
Run with `$ omc minimalExample.mos` on your favorite unix-like shell or use CMD `>"C:\Program Files\OpenModelica1.17.0-dev-64bit\bin\omc.exe" minimalExample.mos`

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

### Screenshots
If applicable, add screenshots to help explain your problem.

### Additional files
You can add additional zip files via drag-and-drop, e.g. for your minimal working example.
Please use `File->Save Total` in OMEdit to save a model and all its dependencies to a single file.

### Version and OS
- OpenModelica Version [run `omc --version` or check `Help->About OMEdit` from OMEdit]
- Versions of used Modelica libraries if applicable
- OS: [e.g. Windows 10, 64 bit]

### Additional context
Add any other context about the problem here.
11 changes: 11 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### Related Issues

<!-- Link to the issues that are solved with this PR. -->

### Purpose

<!--- Describe the problem or feature. -->

### Approach

<!--- How does this address the problem? -->

0 comments on commit f0c9a0b

Please sign in to comment.