From 508834b85918a79ce51652e0c73356699ab711bb Mon Sep 17 00:00:00 2001 From: Tomas Nozicka Date: Fri, 10 Nov 2023 10:46:47 +0100 Subject: [PATCH] Update GitHub issue templates --- .github/ISSUE_TEMPLATE/bug-report.yaml | 65 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 40 ------------- .github/ISSUE_TEMPLATE/ci-flake.yaml | 18 ++++++ .github/ISSUE_TEMPLATE/feature-request.yaml | 22 +++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 ------- 5 files changed, 105 insertions(+), 62 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/ci-flake.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 00000000000..dd6116d25ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,65 @@ +name: Bug Report +description: Report a bug encountered with Scylla Operator +labels: kind/bug +body: +- type: textarea + id: problem + attributes: + label: What happened? + description: | + Please provide as much info as possible. Ensuring all details are shared in your report will help us address your bug in a timely manner. + validations: + required: true + +- type: textarea + id: expected + attributes: + label: What did you expect to happen? + validations: + required: true + +- type: textarea + id: repro + attributes: + label: How can we reproduce it (as minimally and precisely as possible)? + validations: + required: true + +- type: textarea + id: operatorVersion + attributes: + label: Scylla Operator version + validations: + required: true + +- type: textarea + id: kubernetesPlatform + attributes: + label: Kubernetes platform name and version + value: | +
+ ```console + $ kubectl version + # paste output here + ``` + + Kubernetes platform info: +
+ validations: + required: true + +- type: textarea + id: must-gather + attributes: + label: | + Please attach the must-gather archive. The must-gather archive is a **mandatory** part of every bug report. + See https://operator.docs.scylladb.com/stable/support/must-gather.html to learn how you can collect it. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: true + +- type: textarea + id: additional + attributes: + label: Anything else we need to know? diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index ba241e0a58c..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: kind/bug -assignees: '' - ---- - - - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Create Operator ... -2. Perform this action ... -3. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Config Files** -If relevant, upload your configuration files here using GitHub, there is no need to upload them to any 3rd party services - -**Logs** -Please, provide `kubectl get events`, `kubectl logs -n scylla pod-name` and other relevant information. - -**Environment:** - - Platform: (GKE, Azure, minikube, custom...) - - Kubernetes version: - - Scylla version: - - Scylla-operator version: e.g.: master, 8e155d0... - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/ci-flake.yaml b/.github/ISSUE_TEMPLATE/ci-flake.yaml new file mode 100644 index 00000000000..030159f50e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ci-flake.yaml @@ -0,0 +1,18 @@ +name: CI Flake +description: Report CI jobs that flaked +labels: kind/flake +body: +- type: textarea + id: jobref + attributes: + label: Link to the job that flaked. + validations: + required: true + +- type: textarea + id: details + attributes: + label: Snippet of what failed. + description: Insert a short snippet of what failed to have a quick preview (stack trace) and something to track even if logs are gone. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 00000000000..9a59b6e8de2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,22 @@ +name: Feature request +description: Create a feature request +labels: kind/feature +body: +- type: textarea + id: expected + attributes: + label: What should the feature do? + validations: + required: true + +- type: textarea + id: expected + attributes: + label: What is the use case behind this feature? + validations: + required: true + +- type: textarea + id: additional + attributes: + label: Anything else we need to know? diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 0cafb4af64c..00000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: kind/enhancement -assignees: '' - ---- - - - -**Is this a bug report or feature request?** -* Feature Request - -**What should the feature do:** - -**What is use case behind this feature:** - -**Additional Information:**