From 0ac67a9e8906d0e5c4a5e9cf4ec5f8be8df373c1 Mon Sep 17 00:00:00 2001 From: Carlos Coelho <80289056+carlosrcoelho@users.noreply.github.com> Date: Wed, 24 Jul 2024 15:13:22 -0300 Subject: [PATCH] chore(template): adjust bug report template to include screenshot and WIP sections (#2899) * Update bug-report.yaml * Update bug-report.yaml * Update feature-request.yaml * Create work-in-progress.yaml --- .github/ISSUE_TEMPLATE/bug-report.yaml | 16 ++++-- .github/ISSUE_TEMPLATE/feature-request.yaml | 2 - .github/ISSUE_TEMPLATE/work-in-progress.yaml | 58 ++++++++++++++++++++ 3 files changed, 68 insertions(+), 8 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/work-in-progress.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 8ba7a1fbb..94419e3ab 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -105,12 +105,16 @@ body: - "3.11" - "3.10" - - type: markdown + - type: textarea + id: screenshot attributes: - value: | - Screenshot error - If applicable, add screenshots to help explain your problem. + label: Screenshot + description: "If applicable, add screenshots to help explain your problem." + placeholder: "Paste your screenshot here." - - type: markdown + - type: textarea + id: flow-file attributes: - value: | - Flow file - Add your flow if applicable to help replicate the problem. + label: Flow File + description: "Add your flow if applicable to help replicate the problem." + placeholder: "Add your flow link here." diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index 6b494c6f7..1a6862a62 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -22,8 +22,6 @@ body: - type: textarea id: contribution - validations: - required: true attributes: label: Your Contribution description: | diff --git a/.github/ISSUE_TEMPLATE/work-in-progress.yaml b/.github/ISSUE_TEMPLATE/work-in-progress.yaml new file mode 100644 index 000000000..213cbe876 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/work-in-progress.yaml @@ -0,0 +1,58 @@ +name: Work in Progress +description: Use this template to describe the new feature or improvement you are currently working on. +labels: [enhancement] + +body: + - type: markdown + attributes: + value: | + ## Work in Progress + + Thank you for contributing to our project! Please fill out the sections below to describe the new feature or improvement you are currently working on. + + - type: input + id: title + attributes: + label: Title + description: Provide a concise title for your feature or improvement. + placeholder: "Short and descriptive title" + validations: + required: true + + - type: dropdown + id: type + attributes: + label: Type + description: Is this a new feature or an improvement? + options: + - New Feature + - Improvement + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: Provide a detailed description of the feature or improvement. + placeholder: "Explain the feature or improvement in detail" + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use Case + description: Describe the use case or user story that this feature or improvement addresses. + placeholder: "As a [user], I want to [do something] so that [benefit]." + validations: + required: false + + - type: textarea + id: implementation + attributes: + label: Implementation Plan + description: Outline your plan for implementing this feature or improvement. + placeholder: "Describe how you plan to implement this feature or improvement." + validations: + required: false