Open flexseth opened 6 months ago
Sample issue: WordPress user has installed a plugin and something weird is happening
Suggested workflow: Provide steps to troubleshoot origination of issue, offer help with searching this repo for relevant discussions. If troubleshooting doesn't work, and issue hasn't been discussed, open ticket
error may be because of a plugin
etc. Direct the user on how to troubleshoot first, before opening up an Issue
+1 to this ❤️
@adamziel - I'll start working on "canned responses" to issues if you will, ie:
- questions that might help us troubleshoot and/or reproduce your issue:
- What OS are you using?
- What browser version?
- Do you see any relevant errors in the dev tools network tab?
- Are you running with the latest commits from this repo?
via https://github.com/WordPress/wordpress-playground/issues/1180#issuecomment-2033091170
What version of Playground are you running?
wp-now
Route to various issue templates with known limitations, best practices for troubleshooting, etc
These templates can be created by looking at previously resolved issues and re-creating those journeys. Testing and adjusting...
How about starting with a few common templates adapted from these team repos?
How about starting with a few common templates adapted from these team repos?
Thank you for linking these issue templates @ironnysh! The Gutenberg repo has some of the best "issue onboarding" examples and the others probably have great context, too.
I will print all of these templates out and search for common ground with the Playground.
re: including sha
checksums and local file info in error reports, publicly on GitHub
About errors on the filesystem I wouldnt recommend having users post that onto github since once its public, its public. What you could do is make a github action that follows up to all new tickets with a commend asking them to submit their ticket # + that info into like a google form or something along those lines
From WordPress security folks
I will print all of these templates out and search for common ground with the Playground.
This totally didn't work BTW 😢 - I'm old school and like to print stuff to mark-up. :)
Marked as high priority, this totally needs to be done before the contributor day.
PR to include an Issue template for online version of the playground
IE: playground.wordpress.net
PR for an issue template for Playground Tools
Both PRs have been updated- please review at your convenience, @adamziel
Issue templates allow repository owners to provide guard rails when submitting a new issue to a repo.
Is the issue a feature request? Perceived bug? General question about architecture..?
Setting up templates for when a user clicks
New Issue
could be invaluable for saving time and offering troubleshooting steps up front. If the user is unable to find relevant information, issue templates can guide the user how to best submit a request.When going through the issue template flow, labels can be automatically assigned to the issue to provide better filtering.
Sample issue templates
From the Documentation Issue Tracker
Resources
Configuring issue templates in GitHub repositories
Issue templates for Gutenberg