From c5fa8327b9c7e03ea12ddc8a96b5207f1e8c9ec6 Mon Sep 17 00:00:00 2001
From: Lauren Clisby <lauren.clisby@tno.nl>
Date: Wed, 25 Oct 2023 14:12:25 +0200
Subject: [PATCH] Updated issue templates

---
 .github/ISSUE_TEMPLATE/ADDITION-REQUEST.yml   | 32 +++++--------------
 .github/ISSUE_TEMPLATE/BUG-REPORT.yml         |  2 +-
 .../ISSUE_TEMPLATE/IMPROVEMENT-REQUEST.yml    | 28 ++++++----------
 3 files changed, 19 insertions(+), 43 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/ADDITION-REQUEST.yml b/.github/ISSUE_TEMPLATE/ADDITION-REQUEST.yml
index 947def7e..78739235 100644
--- a/.github/ISSUE_TEMPLATE/ADDITION-REQUEST.yml
+++ b/.github/ISSUE_TEMPLATE/ADDITION-REQUEST.yml
@@ -1,37 +1,21 @@
 name: "Addition Request"
-description: Create a ticket for a new addition (or feature) request
+description: Create a ticket to request a new addition (or feature)
 title: "<title>"
 labels: ["Type: addition"]
 body:
     - type: textarea
-      id: summary
+      id: description
       attributes:
-          label: "Summary"
-          description: Provide a brief explanation of the feature
-          placeholder: Describe in a few lines your feature request
+          label: "Description"
+          description: Provide an explanation of the addition
+          placeholder: Describe your addition request
       validations:
           required: true
     - type: textarea
-      id: basic_example
+      id: related_issues
       attributes:
-          label: "Basic Example"
-          description: Indicate here some basic examples of your feature.
-          placeholder: A few specific words about your feature request.
-      validations:
-          required: true
-    - type: textarea
-      id: drawbacks
-      attributes:
-          label: "Drawbacks"
-          description: What are the drawbacks/impacts of your feature request ?
-          placeholder: Identify the drawbacks and impacts while being neutral on your feature request
-      validations:
-          required: true
-    - type: textarea
-      id: reference_issues
-      attributes:
-          label: "Reference Issues"
-          description: Common issues
+          label: "Related Issues"
+          description: Existing issues related to this addition
           placeholder: "#Issues IDs"
       validations:
           required: false
diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
index 847e3c5b..aeacf883 100644
--- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
+++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
@@ -15,7 +15,7 @@ body:
       id: reprod
       attributes:
           label: "Reproduction steps"
-          description: Please enter an explicit description of your issue
+          description: Please describe steps to reproduce your issue
           value: |
               1. Go to '...'
               2. Using input data '....'
diff --git a/.github/ISSUE_TEMPLATE/IMPROVEMENT-REQUEST.yml b/.github/ISSUE_TEMPLATE/IMPROVEMENT-REQUEST.yml
index 3a1208a1..91227a37 100644
--- a/.github/ISSUE_TEMPLATE/IMPROVEMENT-REQUEST.yml
+++ b/.github/ISSUE_TEMPLATE/IMPROVEMENT-REQUEST.yml
@@ -6,32 +6,24 @@ body:
     - type: textarea
       id: summary
       attributes:
-          label: "Summary"
-          description: Provide a brief explanation of the improvement
-          placeholder: Describe in a few lines your improvement request
-      validations:
-          required: true
-    - type: textarea
-      id: basic_example
-      attributes:
-          label: "Basic Example"
-          description: Indicate here some basic examples of your improvement.
-          placeholder: A few specific words about your improvement request.
+          label: "What and Why"
+          description: Explain the improvement
+          placeholder: Describe your request, including why it's an improvement
       validations:
           required: true
     - type: textarea
       id: drawbacks
       attributes:
-          label: "Drawbacks"
-          description: What are the drawbacks/impacts of your improvement request ?
-          placeholder: Identify the drawbacks and impacts while being neutral on your improvement request
+          label: "Possible Drawbacks"
+          description: What are possible drawbacks of your improvement request?
+          placeholder: Identify the drawbacks, while remaining neutral
       validations:
-          required: true
+          required: false
     - type: textarea
-      id: reference_issues
+      id: related_issues
       attributes:
-          label: "Reference Issues"
-          description: Common issues
+          label: "Related Issues"
+          description: Existing issues related to this improvement
           placeholder: "#Issues IDs"
       validations:
           required: false