599 enhancement discussion improvements for the new issue templates (#694)

xsaschako · reneSchm · web-flow · commit 9740ac06eebf · 2023-07-31T10:49:06.000+02:00
Signed-off-by: Sascha Korf &lt;51127093+xsaschako@users.noreply.github.com&gt;
Co-authored-by: reneSchm &lt;rene.schmieding@outlook.com&gt;
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -3,67 +3,67 @@ description: "Use this template to report bugs."
 labels:
   - "class::bug"
 body:
-- type: markdown
-  attributes:
-    value: "Please check our [existing issues](https://github.com/DLR-SC/memilio/issues) beforehand."
-- type: textarea
-  id: bug-desc
-  attributes:
-    label: Bug description
-    description: |
-      Describe the bug. 
-  validations:
-    required: true
-- type: dropdown
-  id: version
-  attributes:
-    label: Version
-    description: Which operating system are you using?
-    options:
-      - Windows
-      - Linux
-      - Mac
-      - Any
-  validations:
-    required: true
-- type: textarea
-  id: bug-reprod
-  attributes:
-    label: To reproduce
-    description: |
-     List the steps to reproduce the bug. 
-    placeholder: |
-      Steps to reproduce the behavior:
-      1. Go to '...'
-      2. Build software via '....'
-      3. Execute program '....'
-      4. See error
-  validations:
-    required: true
+  - type: markdown
+    attributes:
+      value: "Please check our [existing issues](https://github.com/DLR-SC/memilio/issues) beforehand."
+  - type: textarea
+    id: bug-desc
+    attributes:
+      label: Bug description
+      description: |
+        Describe the bug.
+    validations:
+      required: true
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: Which operating system are you using?
+      options:
+        - Windows
+        - Linux
+        - Mac
+        - Github (CI, Actions, etc.)
+        - Any
+    validations:
+      required: true
+  - type: textarea
+    id: bug-reprod
+    attributes:
+      label: To reproduce
+      description: |
+        List the steps to reproduce the bug.
+      placeholder: |
+        Steps to reproduce the behavior:
+        1. Go to '...'
+        2. Build software via '....'
+        3. Execute program '....'
+        4. See error
+    validations:
+      required: true
 
-- type: textarea
-  id: logs
-  attributes:
-    label: Relevant log output
-    description: Please copy and paste any relevant log output. This will be automatically formatted into code.
-    render: zsh
-- type: textarea
-  id: add_info
-  attributes:
-    label: Add any relevant information, e.g. used compiler, screenshots.
-    render: zsh
-    placeholder: |
-      - Compiler: [e.g. gcc 10]
-      - Used libraries [e.g. HDF5 1.10.7,  OpenMPI 4.1.4, ...]
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code.
+      render: zsh
+  - type: textarea
+    id: add_info
+    attributes:
+      label: Add any relevant information, e.g. used compiler, screenshots.
+      render: zsh
+      placeholder: |
+        - Compiler: [e.g. gcc 10]
+        - Used libraries [e.g. HDF5 1.10.7,  OpenMPI 4.1.4, ...]
 
-- type: checkboxes
-  id: checks
-  attributes:
-    label: Checklist
-    description: Add Labels and add this issue to a project.
-    options:
-      - label: "Attached labels, especially loc:: or model:: labels."
-        required: false
-      - label: Linked to project
-        required: false
- 
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checklist
+      description: Add Labels and add this issue to a project.
+      options:
+        - label: "Attached labels, especially loc:: or model:: labels."
+          required: false
+        - label: Linked to project
+          required: false
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,13 +1,12 @@
-## Changes
+# Changes and Information
 
-Please briefly list the changes made:
+Please **briefly list the changes** made, additional Information and what the Reviewer should look out for:
 
-[Describe here in 2-3 lines. For details, reference to issues to avoid redundant information.]
+-
 
-## Merge Request - GuideLine Checklist
+## Merge Request - Guideline Checklist
 
-- *Check our [git workflow](https://github.com/DLR-SC/memilio/wiki/git-workflow) before opening a Pull request/Merge request.*
-- *Request a reviewer when your work is ready to review, before this please use the draft feature.*
+Please check our [git workflow](https://github.com/DLR-SC/memilio/wiki/git-workflow). Use the **draft** feature if the Pull Request is not yet ready to review.
 
 ### Checks by code author
 
@@ -24,7 +23,3 @@ Please briefly list the changes made:
 - [ ] Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
 - [ ] Appropriate **unit tests** have been added, CI passes and code coverage is acceptable (did not decrease)
 - [ ] No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
-
-### Additional context
-
-Please list additional information or things a reviewer should look out for.
diff --git a/.github/workflows/epidata_main.yml b/.github/workflows/epidata_main.yml
@@ -112,7 +112,7 @@ jobs:
         run: |
           for pkg in `ls pycode/wheelhouse/*cp38*.whl`; do python -m pip install $pkg; done # packages that contain native extensions are version specific
           for pkg in `ls pycode/wheelhouse/*py3*.whl`; do python -m pip install $pkg; done # pure python packages are not version specific
-      - name: Dowload Data
+      - name: Download Data
         run: |
           mkdir -p data_dl
           getcasedata -o data_dl --no-progress-indicators
