From 502a4e006407e820b15ae49e6ec6d8afd6e77c43 Mon Sep 17 00:00:00 2001 From: "Michael S. Molina" Date: Mon, 18 Dec 2023 11:07:14 -0300 Subject: [PATCH 1/3] chore: Updates the bug report template --- .github/ISSUE_TEMPLATE/bug-report.md | 49 -------------- .github/ISSUE_TEMPLATE/bug-report.yml | 98 +++++++++++++++++++++++++++ RELEASING/README.md | 11 +-- 3 files changed, 104 insertions(+), 54 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index edb58358a1de7..0000000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -name: Bug report -about: "Create a report to help us improve Superset's stability! For feature requests please open a discussion [here](https://github.com/apache/superset/discussions/categories/ideas)." -labels: bug ---- - -A clear and concise description of what the bug is. - -#### How to reproduce the bug - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -### Expected results - -what you expected to happen. - -### Actual results - -what actually happens. - -#### Screenshots - -If applicable, add screenshots to help explain your problem. - - -### Environment - -(please complete the following information): - -- browser type and version: -- superset version: `superset version` -- python version: `python --version` -- node.js version: `node -v` -- any feature flags active: - -### Checklist - -Make sure to follow these steps before submitting your issue - thank you! - -- [ ] I have checked the superset logs for python stacktraces and included it here as text if there are any. -- [ ] I have reproduced the issue with at least the latest released version of superset. -- [ ] I have checked the issue tracker for the same issue and I haven't found one similar. - -### Additional context - -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000000..24d8b8e043f12 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,98 @@ +name: Bug report +description: File a bug report to improve Superset's stability +labels: ["bug"] +body: + - 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 + - "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, 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 checked the issue tracker for the same issue and I haven't found one similar. + - label: I have checked Superset logs for Python stacktraces and included it here as text if there are any. + validations: + required: true diff --git a/RELEASING/README.md b/RELEASING/README.md index b007a891700b9..4761bf0d9c0f2 100644 --- a/RELEASING/README.md +++ b/RELEASING/README.md @@ -417,11 +417,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. @@ -487,3 +482,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.md` and `UPDATING.md`. + +We also need to update the Environment section of `ISSUE_TEMPLATE/bug-report.yml` to reflect the new release changes. This includes removing versions that are not supported anymore and adding new ones. From 89a36a16058bfd9751cb6fc8aeb5ca5ddd35a344 Mon Sep 17 00:00:00 2001 From: "Michael S. Molina" Date: Fri, 29 Dec 2023 09:38:42 -0300 Subject: [PATCH 2/3] Adds review suggestions --- .github/ISSUE_TEMPLATE/bug-report.yml | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 24d8b8e043f12..b79acd184d826 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,7 +1,15 @@ name: Bug report -description: File a bug report to improve Superset's stability +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: @@ -30,15 +38,13 @@ body: 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). + 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 + - master / latest-dev - "3.1.0" - "3.0.3" validations: @@ -83,8 +89,7 @@ body: 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, etc. + 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: @@ -92,7 +97,7 @@ body: 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 checked the issue tracker for the same issue and I haven't found one similar. - - label: I have checked Superset logs for Python stacktraces and included it here as text if there are any. + - 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 From a578e697148d32b09da96ffc486e462c32a73a2b Mon Sep 17 00:00:00 2001 From: "Michael S. Molina" Date: Wed, 3 Jan 2024 11:43:57 -0300 Subject: [PATCH 3/3] Adds hyperlinks --- RELEASING/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/RELEASING/README.md b/RELEASING/README.md index 4761bf0d9c0f2..1a6c8c13ad078 100644 --- a/RELEASING/README.md +++ b/RELEASING/README.md @@ -485,6 +485,6 @@ At this point, a GitHub action will run that will check whether this release's v ### 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.md` and `UPDATING.md`. +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` to reflect the new release changes. This includes removing versions that are not supported anymore and adding new ones. +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.