From 0d52d19e21152b27a1d8aa375f8d753339caa393 Mon Sep 17 00:00:00 2001 From: matt abrams <37156449+zuchka@users.noreply.github.com> Date: Mon, 1 May 2023 11:25:09 -1000 Subject: [PATCH] GH Issues: replace markdown-based Bug Report form w/ YAML-based form (#67244) * replaces markdown report w yaml * switch to opentext + feedback changes --- .github/ISSUE_TEMPLATE/0-bug-report.yaml | 177 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/1-bug_report.md | 31 ---- .github/ISSUE_TEMPLATE/1-staff_issues.md | 5 + 3 files changed, 182 insertions(+), 31 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/0-bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/1-bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/1-staff_issues.md diff --git a/.github/ISSUE_TEMPLATE/0-bug-report.yaml b/.github/ISSUE_TEMPLATE/0-bug-report.yaml new file mode 100644 index 00000000000..56476cb716c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0-bug-report.yaml @@ -0,0 +1,177 @@ +name: New Bug Report +description: File a bug report +title: "Product-Area-Here: short description of bug here" +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + Please try to give your issue a good title. Try using the product-area where you are having an issue and a brief description of the problem. Like this: + - `Dashboards: Template Variables break when I do X` or + - `Alerting: message templating plus Slack channel breaks when I do X` + - type: markdown + attributes: + value: | + **HINT:** Have you tried [searching](https://github.com/grafana/grafana/issues) for similar issues? Duplicate issues are common. + + **Are you reporting a security vulnerability?** [Submit it here instead](https://github.com/grafana/grafana/security/policy). + - type: markdown + attributes: + value: | + # + - type: textarea + id: bug-describe + attributes: + label: | + + # What went wrong? + + description: | + # + Describe your bug. What happened? What did you expect to happen? + + **Hot Tip:** Record your screen and add it here as a gif. + placeholder: Tell us what you see! + value: | + **What happened**: + + - + + **What did you expect to happen**: + + - + + validations: + required: true + - type: markdown + attributes: + value: | + # + - type: textarea + id: bug-repro + attributes: + label: | + + # How do we reproduce it? + + description: | + # + + Whenever possible, please provide **detailed** steps for reproducing your bug. + + **This is very helpful info** + placeholder: "Step 1:..." + value: | + **Step 1**: + + - Open Grafana and do X + + **Step 2**: + + - Now click button Y + + **Step 3**: + + - Wait for the browser to crash. Error message says: "Error..." + validations: + required: true + - type: markdown + attributes: + value: | + # + - type: input + id: gf-version + attributes: + label: | + + # What Grafana version are you using? + + description: | + # + - [How do I find my Grafana version info?](https://community.grafana.com/t/how-to-find-your-grafana-version-info-3-different-ways/86857) + placeholder: "ex: v9.5.0, or v9.5.0-cloud.5.a016665c (b2a5d45589)" + validations: + required: true + - type: markdown + attributes: + value: | + # + # + # Optional Questions: + # + - type: textarea + id: get-help + attributes: + label: | + + ## Optional Questions: + + ### Is the bug inside a Dashboard Panel? + + description: | + If the bug appears inside a [dashboard panel](https://grafana.com/docs/grafana/latest/panels-visualizations/#panels-and-visualizations), please use the ["Get-Help" feature](https://grafana.com/docs/grafana/latest/troubleshooting/send-panel-to-grafana-support/). Select **copy to clipboard** and paste the data below. + No need for backticks--this text will get formatted as a code-block. + + What's a [dashboard panel](https://grafana.com/docs/grafana/latest/panels-visualizations/#panels-and-visualizations)? + placeholder: Copy "get-help" data here + value: Copy the panel's ["get-help" data](https://grafana.com/docs/grafana/latest/troubleshooting/send-panel-to-grafana-support/) here + - type: dropdown + id: gf-deployment + attributes: + label: Grafana Platform? + description: | + **How** are you running/deploying Grafana? + options: + - I use Grafana Cloud + - Docker + - Kubernetes + - A package manager (APT, YUM, BREW, etc.) + - A downloaded binary + - Other + - I don't know + validations: + required: false + - type: input + id: user-os + attributes: + label: User's OS? + description: What operating system are you running locally? + placeholder: "ex. MacOS Big Sur 11.7, or Ubuntu 20.04..." + - type: input + id: user-browser + attributes: + label: User's Browser? + description: Is the bug occuring in Grafana's user-interface? If so, what browsers are you seeing the problem on? You may choose more than one. + placeholder: "ex. Google Chrome Version 112.0.5615.137 (Official Build) (arm64)..." + - type: dropdown + id: regression + attributes: + label: Is this a Regression? + description: | + A regression means that the feature was working, then you upgraded, and now it's broken. + options: + - 'No' + - 'Yes' + validations: + required: false + - type: input + id: gf-datasource + attributes: + label: Are Datasources involved? + description: | + Is this issue specific to a datasource plugin / plugins? Please list all that apply: + placeholder: "ex. Elasticsearch 5.0.0 or Infinity 1.4.1 ..." + - type: markdown + attributes: + value: | + # + # + ## Anything else to add? + # + - type: textarea + id: extra + attributes: + label: | + Anything else to add? + description: Add any extra information here \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.md b/.github/ISSUE_TEMPLATE/1-bug_report.md deleted file mode 100644 index e17d15e3e0e..00000000000 --- a/.github/ISSUE_TEMPLATE/1-bug_report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Bug report -about: Report a bug you found when using Grafana -labels: 'type: bug' ---- - - - -## What happened: - -## What you expected to happen: - -## How to reproduce it (as minimally and precisely as possible): - -## Anything else we need to know?: - -## Environment: -- Grafana version: -- Data source type & version: -- OS Grafana is installed on: -- User OS & Browser: -- Grafana plugins: -- Others: diff --git a/.github/ISSUE_TEMPLATE/1-staff_issues.md b/.github/ISSUE_TEMPLATE/1-staff_issues.md new file mode 100644 index 00000000000..48aa91e08c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-staff_issues.md @@ -0,0 +1,5 @@ +--- +name: Staff Issues +about: Blank issue for Grafana staff members +labels: 'internal' +---