Преглед на файлове

docs: convert markdown issue templates to issue forms (#1238)

* docs: convert markdown issue templates to issue forms

* chore: update placeholder of Taipy release version

Co-authored-by: Vuillemot Florian <vuillemot.florian@outlook.fr>

* chore: add grammar suggestions

* chore: replace label typo with the label of documentation in the repo

---------

Co-authored-by: Vuillemot Florian <vuillemot.florian@outlook.fr>
Co-authored-by: Jean-Robin <jeanrobin.medori@avaiga.com>
Anmol Baranwal преди 1 година
родител
ревизия
9f854e86cb

+ 130 - 0
.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,130 @@
+name: "🐛 Bug Report"
+description: I would like to report a bug.
+title: "[🐛 BUG] <write a small description here>"
+labels: ["💥Malfunction"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        - Thank you for using Taipy and taking the time to report a bug! 😄 
+        - Please try to spend some time to understand the bug and reproduce it.
+        - 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:
+      label: "What went wrong? 🤔"
+      description: Please provide a detailed description of the issue you encountered. Be clear and concise in explaining what is not working as expected.
+      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:
+      label: "Steps to Reproduce Issue"
+      description: If possible, please share the steps to reproduce the issue.
+      value: |
+        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: "Expected behavior"
+      description: If you have any ideas of the expected behavior, please provide them in this section.
+      placeholder: The description of the expected behavior of the problem.
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "Screenshots"
+      description: If applicable, add screenshots to help explain your problem.
+      value: |
+        ![DESCRIPTION](LINK.png)
+      render: bash
+    validations:
+      required: false
+  - type: input
+    id: environment
+    attributes:
+      label: "Runtime Environment"
+      description: You can specify your operating system and version, web browser and version, or any other software that may be related to the issue.
+      placeholder: ex. Windows 10, Chrome 91.0.4472.124
+    validations:
+      required: false
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: "Browsers"
+      description: What browser(s) are you seeing the problem on?
+      multiple: true
+      options:
+        - Chrome
+        - Firefox
+        - Safari
+        - Microsoft Edge
+        - Opera
+        - Brave
+        - Other
+    validations:
+      required: false
+  - type: dropdown
+    id: os
+    attributes:
+      label: "OS"
+      description: Please select the operating system(s) on which you are experiencing the issue from the dropdown list provided.
+      multiple: true
+      options:
+        - Windows
+        - Linux
+        - Mac
+        - iOS
+        - Android
+        - Other
+    validations:
+      required: false
+  - type: input
+    id: version_taipy
+    attributes:
+      label: "Version of Taipy"
+      description: Please provide the version number of taipy you are using (if applicable) in the text field provided. This can help developers determine if the issue has already been solved in a newer version of the software.
+      placeholder: ex. 3.0.1
+    validations:
+      required: false
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: "Additional Context"
+      description: If you have any additional context or information that may help us understand the problem better, please provide it here.
+      placeholder: This can include any relevant logs, error messages, or other information that may be useful in diagnosing the issue.
+      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
+        - label: "Create a related issue in taipy-doc for documentation and Release Notes if relevant."
+          required: true
+  - type: checkboxes
+    id: terms_checklist_bug
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Avaiga/taipy/blob/develop/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/Avaiga/taipy/blob/develop/CONTRIBUTING.md).
+      options:
+        - label: "I have checked the [existing issues](https://github.com/Avaiga/taipy/issues?q=is%3Aissue+)."
+          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! 😄

+ 0 - 46
.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,46 +0,0 @@
----
-name: Bug report
-about: Bug reports help improve the product quality.
-title: BUG-
-labels: "\U0001F4A5Malfunction"
-assignees: ''
-
----
-
-**Description**
-A complete and clear description of the problem.
-
-**How to reproduce**
-
-- A code fragment
-    ```python
-    from taipy import ...
-    ```
-
-- And/or configuration files or code:
-    ```python
-    from taipy import Config;
-
-
-    Config.configure_data_node(...)
-    ...
-    ```
-
-- And/or Taipy GUI Markdown or HTML files
-
-**Expected behavior**
-Description of what would be the expected outcome.
-
-**Screenshots**
-When available and relevant, screenshots to better highlight the problem.
-
-**Runtime environment**
-Please specify relevant indications.
- - Taipy version (or branch name):
- - OS: [e.g. Linux, Windows] and version
- - Browser: [e.g. Chrome, Edge, Safari] and version (if relevant)
-and any other relevant information.
-
-**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 if relevant

+ 44 - 0
.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,44 @@
+name: "📋 Documentation"
+description: "Use this form to present your suggestions on how to improve our docs."
+title: "[DOCS] <write a small description here>"
+labels: ["📄 Documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        - 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:
+      label: "Issue Description"
+      description: "Please provide a brief summary of the documentation issue you are experiencing or would like to address."
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots_examples_docs
+    attributes:
+      label: "Screenshots or Examples (if applicable)"
+      description: "Please include relevant screenshots or examples to help illustrate the problem."
+
+  - type: textarea
+    id: proposed_solution_docs
+    attributes:
+      label: "Proposed Solution (optional)"
+      description: "If you have a proposed solution for the documentation issue, please provide it here. This can be helpful for speeding up the resolution process."
+
+  - type: checkboxes
+    id: terms_checklist_docs
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Avaiga/taipy/blob/develop/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/Avaiga/taipy/blob/develop/CONTRIBUTING.md).
+      options:
+        - label: "I have checked the [existing issues](https://github.com/Avaiga/taipy/issues?q=is%3Aissue+)."
+          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! 😄

+ 0 - 16
.github/ISSUE_TEMPLATE/feature-improvement.md

@@ -1,16 +0,0 @@
----
-name: Feature improvement
-about: Feature improvements add extra functionality to an existing feature.
-title: ''
-labels: "\U0001F4C8 Improvement"
-assignees: ''
-
----
-
-**Description**
-What this improvement addresses (performance, API...).
-
-**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

+ 64 - 0
.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,64 @@
+name: 💡 Feature Request
+description: Have any new idea or new feature for Taipy? Please suggest!
+title: "[Feature] <write a small description here>"
+labels: ["✨New feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        - 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:
+      label: "Description"
+      description: Please describe the lacking functionality that this issue would address.
+      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:
+      label: "Additional Context"
+      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
+        - 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
+  - type: checkboxes
+    id: terms_checklist_feature
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Avaiga/taipy/blob/develop/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/Avaiga/taipy/blob/develop/CONTRIBUTING.md).
+      options:
+        - label: "I have checked the [existing issues](https://github.com/Avaiga/taipy/issues?q=is%3Aissue+)."
+          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! 😄

+ 0 - 27
.github/ISSUE_TEMPLATE/new-feature.md

@@ -1,27 +0,0 @@
----
-name: New feature
-about: Suggest a new feature for the product.
-title: ''
-labels: "✨New feature"
-assignees: ''
-
----
-
-**What would that feature address**
-Description of the lacking functionality that this issue would address.
-Ex: It is not possible to do this or that...
-
-***Description of the ideal solution***
-What would be the best way to provide that functionality
-
-***Caveats***
-What impact could that feature have on the rest of the product, and should be taken special care of?
-
-***Other options***
-What else could we do (workaround, third-party...)?
-
-**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

+ 30 - 0
.github/ISSUE_TEMPLATE/other.yml

@@ -0,0 +1,30 @@
+name: Other
+description: Use this for any other question or issue. Please do not create blank issues.
+title: "[OTHER] <write a small description here>"
+labels: ["discussion"]
+body:
+  - type: markdown
+    attributes:
+      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:
+      label: What would you like to share or ask?
+      description: Provide a clear and concise explanation of your issue.
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms_checklist_discussion
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Avaiga/taipy/blob/develop/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/Avaiga/taipy/blob/develop/CONTRIBUTING.md).
+      options:
+        - label: "I have checked the [existing issues](https://github.com/Avaiga/taipy/issues?q=is%3Aissue+)."
+          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! 😄

+ 40 - 0
.github/ISSUE_TEMPLATE/refactor-code.yml

@@ -0,0 +1,40 @@
+name: 🔧 Refactor Code/Feature Improvement
+description: Use this form for code refactoring tasks or existing feature improvement.
+title: "[Refactor] <write a small description here>"
+labels: ["📈 Improvement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        - Thank you for using Taipy and taking the time to suggest feature improvements! 😄
+  - type: textarea
+    id: refactor_description
+    attributes:
+      label: "Description"
+      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
+        - 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
+  - type: checkboxes
+    id: terms_checklist_refactor
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Avaiga/taipy/blob/develop/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/Avaiga/taipy/blob/develop/CONTRIBUTING.md).
+      options:
+        - label: "I have checked the [existing issues](https://github.com/Avaiga/taipy/issues?q=is%3Aissue+)."
+          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! 😄