chore: Updates the bug report template (apache#26375)

sfirke · Mar 22, 2024 · e54df27 · e54df27
1 parent 2dbccab
commit e54df27
Show file tree

Hide file tree

Showing 3 changed files with 109 additions and 54 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,103 @@
+name: Bug report
+description: Report a bug to improve Superset's stability
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Hello Superset Community member! Please keep things tidy by putting your post in the proper place:
+
+        🐛 Reporting a bug: use this form.
+        🙏 Asking a question or getting help: post in the [Superset Slack chat](http://bit.ly/join-superset-slack) or [GitHub Discussions](https://github.com/apache/superset/discussions) under "Q&A / Help".
+        💡 Requesting a new feature: Search [GitHub Discussions](https://github.com/apache/superset/discussions) to see if it exists already. If not, add a new post there under "Ideas".
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Bug description
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: How to reproduce the bug
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots-recordings
+    attributes:
+      label: Screenshots/recordings
+      description: If applicable, add screenshots or recordings to help explain your problem.
+  - type: markdown
+    attributes:
+      value: |
+        ### Environment
+
+        Please specify your environment. If your environment does not match the alternatives, you need to upgrade your environment before submitting the issue as it may have already been fixed. For additional information about the releases, check out the [release page](https://github.com/apache/superset/wiki).
+  - type: dropdown
+    id: superset-version
+    attributes:
+      label: Superset version
+      options:
+        - master / latest-dev
+        - "3.1.0"
+        - "3.0.3"
+    validations:
+      required: true
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: Python version
+      options:
+        - "3.9"
+        - "3.10"
+        - "3.11"
+        - Not applicable
+        - I don't know
+    validations:
+      required: true
+  - type: dropdown
+    id: node-version
+    attributes:
+      label: Node version
+      options:
+        - "16"
+        - "17"
+        - "18 or greater"
+        - Not applicable
+        - I don't know
+    validations:
+      required: true
+  - type: dropdown
+    id: browser
+    attributes:
+      label: Browser
+      options:
+        - Chrome
+        - Firefox
+        - Safari
+        - Not applicable
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: |
+        Add any other context about the problem here such as the feature flags that you have enabled, any customizations you have made, the data source you are querying, etc.
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      description: Make sure to follow these steps before submitting your issue - thank you!
+      options:
+        - label: I have searched Superset docs and Slack and didn't find a solution to my problem.
+        - label: I have searched the GitHub issue tracker and didn't find a similar bug report.
+        - label: I have checked Superset's logs for errors and if I found a relevant Python stacktrace, I included it here as text in the "additional context" section.
+    validations:
+      required: true
diff --git a/RELEASING/README.md b/RELEASING/README.md
@@ -432,11 +432,6 @@ git tag -f ${SUPERSET_VERSION}
 git push origin ${SUPERSET_VERSION}
 ```
 
-### Update CHANGELOG and UPDATING on superset
-
-Now that we have a final Apache source release we need to open a pull request on Superset
-with the changes on `CHANGELOG.md` and `UPDATING.md`.
-
 ### Publishing a Convenience Release to PyPI
 
 Extract the release to the `/tmp` folder to build the PiPY release. Files in the `/tmp` folder will be automatically deleted by the OS.
@@ -502,3 +497,9 @@ click the 3-dot icon and select `Create Release`, paste the content of the ANNOU
 release notes, and publish the new release.
 
 At this point, a GitHub action will run that will check whether this release's version number is higher than the current 'latest' release. If that condition is true, this release sha will automatically be tagged as `latest` so that the most recent release can be referenced simply by using the 'latest' tag instead of looking up the version number. The existing version number tag will still exist, and can also be used for reference.
+
+### Update Superset files
+
+Now that we have a final Apache release we need to open a pull request on Superset with the changes on [CHANGELOG.m](../CHANGELOG.md) and [UPDATING.md](../UPDATING.md).
+
+We also need to update the Environment section of [ISSUE_TEMPLATE/bug-report.yml](../.github/ISSUE_TEMPLATE//bug-report.yml) to reflect the new release changes. This includes removing versions that are not supported anymore and adding new ones.