Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Updates the bug report template #26375

Merged

Conversation

michael-s-molina
Copy link
Member

@michael-s-molina michael-s-molina commented Dec 28, 2023

SUMMARY

This PR changes the bug report template to make it clearer which versions are officially supported and remove unnecessary sections to simplify the reporting process. Specifically:

  • It converts the issue template to an issue form
  • It changes the Environment section from free form input to a set of dropdowns with predefined options
  • It adds instructions to upgrade to the officially supported environment versions when necessary
  • It removes the Expected/Actual sections as these are generally present in the bug description or can be easily deduced from it.
  • It adds instructions to update the bug template when releasing new versions.

TESTING INSTRUCTIONS

Check GitHub's syntax for issue forms.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be such a nice improvement! I expect it will pay big dividends in saving developer time.

I put in a few suggestions, most of all I would suggest we offer people links to other places to put their post if it is not actually a bug report.

.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
3. Scroll down to '....'
4. See error
validations:
required: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case any other reviewers are wondering, the default is false. So in sections w/o this, they're not required.

.github/ISSUE_TEMPLATE/bug-report.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
@sfirke
Copy link
Member

sfirke commented Dec 28, 2023

Re: testing this, I looked at the GitHub syntax form and everything looked good to me but I didn't create a new repo to actually put this into practice, or run it through a linter. If anything is broken it could be quickly hot-fixed.

@michael-s-molina
Copy link
Member Author

michael-s-molina commented Dec 29, 2023

Re: testing this, I looked at the GitHub syntax form and everything looked good to me but I didn't create a new repo to actually put this into practice, or run it through a linter. If anything is broken it could be quickly hot-fixed.

@sfirke When reviewing the file changes, you can click on the 3 dots and select View file. It will render but it's not 100% accurate. For example, the fields will expand to occupy the available width. You can see an example here.

RELEASING/README.md Outdated Show resolved Hide resolved
Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@sfirke
Copy link
Member

sfirke commented Jan 3, 2024

I looked at it in the preview mode you described, it looks ready to merge to me.

Copy link
Member

@rusackas rusackas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love it!

@michael-s-molina michael-s-molina merged commit 591f266 into apache:master Jan 18, 2024
46 checks passed
Muhammed-baban pushed a commit to intellica-tech/reporting-tool that referenced this pull request Jan 19, 2024
sfirke pushed a commit to sfirke/superset that referenced this pull request Mar 22, 2024
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 4.0.0 labels Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels hold! On hold size/L 🚢 4.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants