From dea88868d3fd2312f642c84738253be26caa5aaa Mon Sep 17 00:00:00 2001 From: FlorianJacta <98709993+FlorianJacta@users.noreply.github.com> Date: Wed, 5 Jun 2024 10:41:54 +0200 Subject: [PATCH 1/3] Change required fields and markdown for screenshots - Screenshot field is now Markdown - Required fields changed - Make break lines consistent in issue forms --- .github/ISSUE_TEMPLATE/bug-report.yml | 5 ++--- .github/ISSUE_TEMPLATE/feature-request.yml | 15 +++++++++++---- .github/ISSUE_TEMPLATE/other.yml | 3 +++ .github/ISSUE_TEMPLATE/refactor-code.yml | 10 +++++++--- 4 files changed, 23 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 2d4951178f..7951098b62 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -47,7 +47,6 @@ body: description: If applicable, add screenshots to help explain your problem. value: | ![DESCRIPTION](LINK.png) - render: bash validations: required: false - type: input @@ -112,9 +111,9 @@ body: 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: checkboxes id: terms_checklist_bug attributes: diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index e7f4921ea6..848a890ba7 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,21 @@ 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 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 related issue in taipy-doc for documentation and Release Notes." - required: true + required: false - label: "Check if a new demo could be provided based on this, or if legacy demos could be benefit from it." - required: true + required: false - label: "Ensure any change is well documented." - required: true + required: false + - type: checkboxes id: terms_checklist_feature attributes: @@ -59,6 +65,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..e697216008 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,19 @@ 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 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: "Propagate any change on the demos and run all of them to ensure there is no breaking change." - required: true + required: false - label: "Ensure any change is well documented." - required: true + required: false + - type: checkboxes id: terms_checklist_refactor attributes: @@ -35,6 +38,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! 😄 From f7b695d9e9cc71f609c31b54063f257521a63625 Mon Sep 17 00:00:00 2001 From: FlorianJacta <98709993+FlorianJacta@users.noreply.github.com> Date: Wed, 5 Jun 2024 15:26:19 +0200 Subject: [PATCH 2/3] Markdown for Acceptance Criteria Transform to Markdown the Acceptance Criteria --- .github/ISSUE_TEMPLATE/bug-report.yml | 21 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.yml | 2 ++ .github/ISSUE_TEMPLATE/feature-request.yml | 22 +++++++++------------- .github/ISSUE_TEMPLATE/refactor-code.yml | 19 ++++++++----------- 4 files changed, 40 insertions(+), 24 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 7951098b62..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: @@ -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 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 848a890ba7..8fcbfbad3d 100644 --- 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 index e697216008..5080e0b783 100644 --- 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! 😄 From 21932d034f4de042ed5d135c438494d84acb9d9f Mon Sep 17 00:00:00 2001 From: FlorianJacta <98709993+FlorianJacta@users.noreply.github.com> Date: Fri, 7 Jun 2024 09:44:30 +0200 Subject: [PATCH 3/3] Fix Acceptance Criteria --- .github/ISSUE_TEMPLATE/bug-report.yml | 12 +----------- .github/ISSUE_TEMPLATE/feature-request.yml | 2 +- .github/ISSUE_TEMPLATE/refactor-code.yml | 2 +- 3 files changed, 3 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 88a042021d..f51d577f11 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -116,20 +116,10 @@ body: 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: false - - label: "Create a related issue in taipy-doc for documentation and Release Notes if relevant." - required: false - - type: markdown attributes: value: | - ## Acceptance Criteria + ### 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. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 8fcbfbad3d..af96e8bb34 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -44,7 +44,7 @@ body: - type: markdown attributes: value: | - ## Acceptance Criteria + ### 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. diff --git a/.github/ISSUE_TEMPLATE/refactor-code.yml b/.github/ISSUE_TEMPLATE/refactor-code.yml index 5080e0b783..5f63f6c76f 100644 --- a/.github/ISSUE_TEMPLATE/refactor-code.yml +++ b/.github/ISSUE_TEMPLATE/refactor-code.yml @@ -19,7 +19,7 @@ body: - type: markdown attributes: value: | - ## Acceptance Criteria + ### 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.