From b12a8d104136a3e7f3c66edde6bf6d703c28eaa5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=E1=B4=87=CA=80=C9=B4=E1=B4=85=20S=E1=B4=84=CA=9C?= =?UTF-8?q?=E1=B4=8F=CA=80=C9=A2=E1=B4=87=CA=80s?= Date: Thu, 28 Apr 2022 09:18:21 +0200 Subject: [PATCH] chore: Update bug-report --- .github/ISSUE_TEMPLATE/bug-report.md | 36 ---------- .github/ISSUE_TEMPLATE/bug-report.yml | 98 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/enhancement.md | 26 ------- .github/ISSUE_TEMPLATE/enhancement.yml | 40 +++++++++++ 5 files changed, 139 insertions(+), 63 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 2c97123a..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: kind:bug -assignees: '' - ---- - -# Details - -**Helm chart name and version:** - - - -**Container name and tag:** - - - -**What steps did you take and what happened:** - - - -**Relevant Helm values:** - - - -**What did you expect to happen:** - -**Anything else you would like to add:** - - - -**Additional Information:** - - diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..52afba7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,98 @@ +--- +name: Bug report +description: Create a report to help us improve +title: '[] Concise description of the issue' +labels: ["bug"] + +# Header + +body: + - type: markdown + attributes: + value: | + Have a question? 👉 [Start a new discussion](https://github.com/k8s-at-home/organization/discussions/new) or [ask on our Discord](https://discord.gg/k8s-at-home). + + Before opening an issue, please check [the documentation](https://docs.k8s-at-home.com/our-helm-charts/introduction/) and see if it helps you resolve your issue. Please also make sure that you followed the installation instructions. + + Finally, please search issues and discussions before opening a new bug report. + +# Helm Chart details + + - type: input + id: chart-name + attributes: + label: Helm chart name + description: Name of the Helm chart this issue relates to + placeholder: e.g. sonarr + validations: + required: true + + - type: input + id: chart-version + attributes: + label: Helm chart version + description: Version of the Helm chart this issue relates to + placeholder: e.g. 16.1.0 + validations: + required: true + +# Container details + + - type: input + id: container-image + attributes: + label: Container name + description: Name of the container image this issue relates to + placeholder: e.g. ghcr.io/k8s-at-home/sonarr + validations: + required: true + + - type: input + id: container-tag + attributes: + label: Container tag + description: Tag of the container image this issue relates to + placeholder: e.g. v3.0.7.1477 + validations: + required: true + +# Issue details + + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: expected-result + attributes: + label: Expected result + description: What did you expect to happen + validations: + required: true + + - type: textarea + id: helm-values + attributes: + label: Helm values to reproduce + description: A snippet of the relevant Helm values + placeholder: | + Enter your relevant YAML values here + render: YAML + validations: + required: true + + - type: textarea + id: other-info + attributes: + label: Additional Information + description: Anything to give further context to the bug report or information that will assist in solving the issue + + - type: textarea + id: repository-link + attributes: + label: Repo link + description: A link to a (public) Git repository where your values are available diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c3c9d4c8..fb819596 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,7 @@ blank_issues_enabled: false contact_links: - name: Discuss on Discord - url: https://discord.com/invite/sTMX7Vh + url: https://discord.gg/k8s-at-home about: Join our Discord community - name: Ask a question url: https://github.com/k8s-at-home/organization/discussions diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index 2f9b6c34..00000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: kind:enhancement -assignees: '' - ---- - -# Details - -**Helm chart name:** - - - -**Describe the solution you'd like:** - - - -**Anything else you would like to add:** - - - -**Additional Information:** - - diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 00000000..10f42327 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,40 @@ +--- +name: Feature request +description: Suggest an idea for this project +title: '[] Concise description of the enhancement' +labels: ["enhancement"] + +# Header + +body: + - type: markdown + attributes: + value: | + Have a question? 👉 [Start a new discussion](https://github.com/k8s-at-home/organization/discussions/new) or [ask on our Discord](https://discord.gg/k8s-at-home). + +# Helm Chart details + + - type: input + id: chart-name + attributes: + label: Helm chart name + description: Name of the Helm chart this issue relates to + placeholder: e.g. sonarr + validations: + required: true + +# Enhancement details + + - type: textarea + id: description + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen + validations: + required: true + + - type: textarea + id: other-info + attributes: + label: Additional Information + description: Anything to give further context to the requested new feature