From b2a6367cc37f24c7787b46cf9f0879d300ee90d8 Mon Sep 17 00:00:00 2001 From: Florian Jacta <98709993+FlorianJacta@users.noreply.github.com> Date: Fri, 7 Jun 2024 08:16:39 +0200 Subject: [PATCH] Change required fields and markdown for screenshots (#1358) * Change required fields and markdown for screenshots - Screenshot field is now Markdown - Required fields changed - Make break lines consistent in issue forms * Markdown for Acceptance Criteria Transform to Markdown the Acceptance Criteria --- .github/ISSUE_TEMPLATE/bug-report.yml | 26 ++++++++++++++++++--- .github/ISSUE_TEMPLATE/documentation.yml | 2 ++ .github/ISSUE_TEMPLATE/feature-request.yml | 27 ++++++++++++---------- .github/ISSUE_TEMPLATE/other.yml | 3 +++ .github/ISSUE_TEMPLATE/refactor-code.yml | 21 +++++++++-------- 5 files changed, 54 insertions(+), 25 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 2d4951178f..88a042021d 100644 --- 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: @@ -47,9 +52,9 @@ body: description: If applicable, add screenshots to help explain your problem. value: | ![DESCRIPTION](LINK.png) - render: bash validations: required: false + - type: input id: environment attributes: @@ -58,6 +63,7 @@ body: placeholder: ex. Windows 10, Chrome 91.0.4472.124 validations: required: false + - type: dropdown id: browsers attributes: @@ -74,6 +80,7 @@ body: - Other validations: required: false + - type: dropdown id: os attributes: @@ -89,6 +96,7 @@ body: - Other validations: required: false + - type: input id: version_taipy attributes: @@ -97,6 +105,7 @@ body: placeholder: ex. 3.0.1 validations: required: false + - type: textarea id: additional_context attributes: @@ -106,15 +115,25 @@ body: render: bash validations: required: false + - type: checkboxes id: acceptance_criteria attributes: label: Acceptance Criteria options: - label: "Ensure new code is unit tested, and check code coverage is at least 90%." - required: true + required: false - label: "Create a related issue in taipy-doc for documentation and Release Notes if relevant." - required: true + 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: @@ -125,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 index 8086b64606..1c8cd9417b 100644 --- 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 index e7f4921ea6..8fcbfbad3d 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -9,6 +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: @@ -17,18 +18,21 @@ body: placeholder: A detailed description of the new feature request. validations: required: true + - type: textarea id: feature_solution_proposed attributes: label: "Solution Proposed" description: A precise description of how you would like to see this functionality implemented. placeholder: Including any relevant materials such as sketches, wireframes, or flowcharts to illustrate your proposal is highly welcomed. + - type: textarea id: feature_impact_solution attributes: label: "Impact of Solution" description: What impact could that feature have on the rest of the product, and should be taken special care of? placeholder: Including any relevant info to understand the impact of solution on the rest of the product. + - type: textarea id: additional_context_feature attributes: @@ -36,19 +40,17 @@ body: description: If you have any additional context or information that may help us to implement this feature, please provide it here. (workaround, third-party...) 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: true - - label: "Create related issue in taipy-doc for documentation and Release Notes." - required: true - - label: "Check if a new demo could be provided based on this, or if legacy demos could be benefit from it." - required: true - - label: "Ensure any change is well documented." - required: true + 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 attributes: @@ -59,6 +61,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 suggest a feature request! 😄 diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml index 04d536bfa2..3d8dbfcba4 100644 --- a/.github/ISSUE_TEMPLATE/other.yml +++ b/.github/ISSUE_TEMPLATE/other.yml @@ -8,6 +8,7 @@ body: value: | - Thank you for using Taipy and taking the time to submit this issue! 😄 - This is for discussion or any questions you may have. + - type: textarea id: issuedescription attributes: @@ -15,6 +16,7 @@ body: description: Provide a clear and concise explanation of your issue. validations: required: true + - type: checkboxes id: terms_checklist_discussion attributes: @@ -25,6 +27,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/refactor-code.yml b/.github/ISSUE_TEMPLATE/refactor-code.yml index 87248a776e..5080e0b783 100644 --- a/.github/ISSUE_TEMPLATE/refactor-code.yml +++ b/.github/ISSUE_TEMPLATE/refactor-code.yml @@ -7,6 +7,7 @@ body: attributes: value: | - Thank you for using Taipy and taking the time to suggest feature improvements! 😄 + - type: textarea id: refactor_description attributes: @@ -14,17 +15,16 @@ body: description: "Describe what improvements can be made(performance, API...) in the codebase without introducing breaking changes." 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: true - - label: "Propagate any change on the demos and run all of them to ensure there is no breaking change." - required: true - - label: "Ensure any change is well documented." - required: true + 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 attributes: @@ -35,6 +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! 😄