Markdown for Acceptance Criteria

Transform to Markdown the Acceptance Criteria
Avaiga · Jun 5, 2024 · f7b695d · f7b695d
1 parent dea8886
commit f7b695d
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 24 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -11,6 +11,7 @@ body:
         - Take a look at our template and try to add as much detail as possible.
         - The more details we have, the easier it would be to fix it. 
         - If any heading is not applicable, please set it to `NA`.
+
   - type: textarea
     id: something_wrong
     attributes:
@@ -19,12 +20,14 @@ body:
       placeholder: The description of the issue you experienced in detail, including any relevant information or context.
     validations:
       required: true
+
   - type: textarea
     id: expected_behavior
     attributes:
       label: "Expected Behavior"
       description: Please describe how you expected the system to behave when you encountered the issue.
       placeholder: The description of the behavior that you expected to see when encountering the issue.
+
   - type: textarea
     id: reproduction_steps
     attributes:
@@ -34,12 +37,14 @@ body:
         1. A code fragment
         2. And/or configuration files or code
         3. And/or Taipy GUI Markdown or HTML files
+
   - type: textarea
     id: solution_proposed
     attributes:
       label: "Solution Proposed"
       description: Any ideas on how this should be solved
       placeholder: The potential solution to solve this issue
+
   - type: textarea
     id: screenshot
     attributes:
@@ -49,6 +54,7 @@ body:
         ![DESCRIPTION](LINK.png)
     validations:
       required: false
+
   - type: input
     id: environment
     attributes:
@@ -57,6 +63,7 @@ body:
       placeholder: ex. Windows 10, Chrome 91.0.4472.124
     validations:
       required: false
+
   - type: dropdown
     id: browsers
     attributes:
@@ -73,6 +80,7 @@ body:
         - Other
     validations:
       required: false
+
   - type: dropdown
     id: os
     attributes:
@@ -88,6 +96,7 @@ body:
         - Other
     validations:
       required: false
+
   - type: input
     id: version_taipy
     attributes:
@@ -96,6 +105,7 @@ body:
       placeholder: ex. 3.0.1
     validations:
       required: false
+
   - type: textarea
     id: additional_context
     attributes:
@@ -105,6 +115,7 @@ body:
       render: bash
     validations:
       required: false
+
   - type: checkboxes
     id: acceptance_criteria
     attributes:
@@ -114,6 +125,15 @@ body:
           required: false
         - label: "Create a related issue in taipy-doc for documentation and Release Notes if relevant."
           required: false
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Acceptance Criteria
+        
+        - [ ] Ensure new code is unit tested, and check code coverage is at least 90%.
+        - [ ] Create related issue in taipy-doc for documentation and Release Notes.
+
   - type: checkboxes
     id: terms_checklist_bug
     attributes:
@@ -124,6 +144,7 @@ body:
           required: true
         - label: "I am willing to work on this issue (optional)"
           required: false
+
   - type: markdown
     attributes:
       value: Thank you for taking the time to report the issue! 😄
diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml
@@ -9,6 +9,7 @@ body:
         - Thank you for using Taipy and taking the time to suggest improvements in documentation! 😄 
         - Take a look at our template and try to add as much detail as possible.
         - If any heading is not applicable, please set it to `NA`.
+        
   - type: textarea
     id: docs_description
     attributes:
@@ -39,6 +40,7 @@ body:
           required: true
         - label: "I am willing to work on this issue (optional)"
           required: false
+
   - type: markdown
     attributes:
       value: Thank you for taking the time to report the issue! 😄
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -9,7 +9,7 @@ body:
         - Thank you for using Taipy and taking the time to suggest a new feature! 😄 
         - Take a look at our template and try to add as much detail as possible. 
         - If any heading is not applicable, please set it to `NA`.
-        
+
   - type: textarea
     id: description_feature
     attributes:
@@ -41,19 +41,15 @@ body:
     validations:
       required: false
 
-  - type: checkboxes
-    id: acceptance_criteria
+  - type: markdown
     attributes:
-      label: Acceptance Criteria
-      options:
-        - label: "Ensure new code is unit tested, and check code coverage is at least 90%."
-          required: false
-        - label: "Create related issue in taipy-doc for documentation and Release Notes."
-          required: false
-        - label: "Check if a new demo could be provided based on this, or if legacy demos could be benefit from it."
-          required: false
-        - label: "Ensure any change is well documented."
-          required: false
+      value: |
+        ## Acceptance Criteria
+        
+        - [ ] Ensure new code is unit tested, and check code coverage is at least 90%.
+        - [ ] Create related issue in taipy-doc for documentation and Release Notes.
+        - [ ] Check if a new demo could be provided based on this, or if legacy demos could be benefit from it.
+        - [ ] Ensure any change is well documented.      
 
   - type: checkboxes
     id: terms_checklist_feature

diff --git a/.github/ISSUE_TEMPLATE/refactor-code.yml b/.github/ISSUE_TEMPLATE/refactor-code.yml
@@ -16,17 +16,14 @@ body:
     validations:
       required: true
 
-  - type: checkboxes
-    id: acceptance_criteria
+  - type: markdown
     attributes:
-      label: Acceptance Criteria
-      options:
-        - label: "Ensure new code is unit tested, and check code coverage is at least 90%."
-          required: false
-        - label: "Propagate any change on the demos and run all of them to ensure there is no breaking change."
-          required: false
-        - label: "Ensure any change is well documented."
-          required: false
+      value: |
+        ## Acceptance Criteria
+        
+        - [ ] Ensure new code is unit tested, and check code coverage is at least 90%.
+        - [ ] Propagate any change on the demos and run all of them to ensure there is no breaking change.
+        - [ ] Ensure any change is well documented.
 
   - type: checkboxes
     id: terms_checklist_refactor
@@ -38,7 +35,7 @@ body:
           required: true
         - label: "I am willing to work on this issue (optional)"
           required: false
-          
+
   - type: markdown
     attributes:
       value: Thank you for taking the time to report the issue! 😄