From 256572a697b5bccf3c3ba8a9e20d0009f4735190 Mon Sep 17 00:00:00 2001 From: Seth Miller Date: Wed, 17 Apr 2024 00:42:53 -0400 Subject: [PATCH 1/9] Added Playground Tools issue templates --- ...---wp-now--vs-code-extension--utilities.md | 82 +++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 playground-tools-issues---wp-now--vs-code-extension--utilities.md diff --git a/playground-tools-issues---wp-now--vs-code-extension--utilities.md b/playground-tools-issues---wp-now--vs-code-extension--utilities.md new file mode 100644 index 00000000..11aab97a --- /dev/null +++ b/playground-tools-issues---wp-now--vs-code-extension--utilities.md @@ -0,0 +1,82 @@ +--- +name: Playground Tools issues - wp-now, VS Code extension, utilities +about: Did a tool not work the way you want it to? Let us know! +title: Report an issue in the Playground Tools repo +labels: bug +assignees: '' + +--- + +## First make sure that you search for related issues in the `Playground Tools` repo's [issues](https://github.com/WordPress/playground-tools/issues) + +if not found... + +## Describe the issue +Please provide a clear and concise description, including step by step instructions to get to the error case you have found. This will include providing info on the configuring, tool, and environmental information. + +## To reproduce behavior +Steps to reproduce the behavior: +1. Enter the tool you are using, and context +2. What mode did you boot Playground in? +3. What specifically were you attempting to do? +4. Show errors from development environment and what you see on the Playground instance + +**Expected behavior** +A clear and concise description of what you expected to happen. + +## Blueprint or no? +Did you send a custom blueprint to the instance, or just boot up as-is? + + +## What protocol is used with the blueprint? +Query API: https://wordpress.github.io/wordpress-playground/apis-overview#query-api +JavaScript API: https://wordpress.github.io/wordpress-playground/apis-overview#javascript-api +PR Previewer - Look in `./testing/PROP.md` for more info + +## paste blueprint as `JSON` code below +The best practice is to copy directly from the code editor, this will retain formatting and readibility in most cases. + +If there are formatting issues, you can use a `JSON` code formatter like https://jsonformatter.org/ +Please copy/paste your blueprint from a code editor, which will retain spacing + +Once copy pasted below, you can delete all of these instructions. +It should be just the the `JSON` code directly below the bold sub-section above. + + +If you chose **No** above - you did not have a blueprint... +Please delete the entire previous section to help keep the issue clean. + +## Screenshots or screen recording +If applicable, add screenshots to help explain your problem. + +**Hint:** To avoid showing your system information, use a tool like [Oh My Zsh!](https://ohmyz.sh/) to hide the folder directory structure if you don't want to send this info + +It can be helpful to show the directory structure for certain issues, use your discretion here. + +## Desktop environment +Please complete the following information + - OS: [e.g. `'nix'`, 'MacOS', 'Windows' or the exact platform build] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file From 4182227a50ebb7d966b22fe17046e66ceed12fe6 Mon Sep 17 00:00:00 2001 From: Seth Miller Date: Wed, 17 Apr 2024 00:53:59 -0400 Subject: [PATCH 2/9] Added error reporting information And link to Site Health screen --- ...---wp-now--vs-code-extension--utilities.md | 20 +++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/playground-tools-issues---wp-now--vs-code-extension--utilities.md b/playground-tools-issues---wp-now--vs-code-extension--utilities.md index 11aab97a..2dc4dc4f 100644 --- a/playground-tools-issues---wp-now--vs-code-extension--utilities.md +++ b/playground-tools-issues---wp-now--vs-code-extension--utilities.md @@ -72,11 +72,27 @@ If applicable, add screenshots to help explain your problem. It can be helpful to show the directory structure for certain issues, use your discretion here. -## Desktop environment +## Error reporting +You can use the [Site Health](https://wordpress.org/documentation/article/site-health-screen/) screen to + - submit WordPress environment info + - submit local system info + +You can use the Playground menu to `Report error`, which will automaticlly send some information and submit to the `#playground-logs` Channel on Making WordPress Slack. + + +## Include Console errors + +Please include the error you see in the console in a code block. + + +## Environmental info Please complete the following information - OS: [e.g. `'nix'`, 'MacOS', 'Windows' or the exact platform build] - Browser [e.g. chrome, safari] - Version [e.g. 22] **Additional context** -Add any other context about the problem here. \ No newline at end of file +Add any other context about the problem here. From 5da5742dcbdcdaeb1bc1ddb20e36f5157140679e Mon Sep 17 00:00:00 2001 From: Seth Miller Date: Wed, 17 Apr 2024 07:39:04 -0400 Subject: [PATCH 3/9] TLDR'd issue template for playground-tools repo Made it to where they can optionally include what they want --- ...round-tools-issues---wp-now--vs-code-extension--utilities.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/playground-tools-issues---wp-now--vs-code-extension--utilities.md b/playground-tools-issues---wp-now--vs-code-extension--utilities.md index 2dc4dc4f..098a5b42 100644 --- a/playground-tools-issues---wp-now--vs-code-extension--utilities.md +++ b/playground-tools-issues---wp-now--vs-code-extension--utilities.md @@ -9,7 +9,7 @@ assignees: '' ## First make sure that you search for related issues in the `Playground Tools` repo's [issues](https://github.com/WordPress/playground-tools/issues) -if not found... +if not found... use whatever sections you want below to describe your issue. ## Describe the issue Please provide a clear and concise description, including step by step instructions to get to the error case you have found. This will include providing info on the configuring, tool, and environmental information. From 8e9739a98aff1142dd56ac8726faaf62b826a552 Mon Sep 17 00:00:00 2001 From: Seth Miller Date: Thu, 25 Apr 2024 22:23:46 -0400 Subject: [PATCH 4/9] Added issue template to correct folder, renamed to match GitHub templates --- .../ISSUE_TEMPLATE.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename playground-tools-issues---wp-now--vs-code-extension--utilities.md => .github/ISSUE_TEMPLATE.md (100%) diff --git a/playground-tools-issues---wp-now--vs-code-extension--utilities.md b/.github/ISSUE_TEMPLATE.md similarity index 100% rename from playground-tools-issues---wp-now--vs-code-extension--utilities.md rename to .github/ISSUE_TEMPLATE.md From c814d9d62acbde4bb0870a2fd62b5b915f0bd33b Mon Sep 17 00:00:00 2001 From: Seth Miller Date: Thu, 25 Apr 2024 22:49:40 -0400 Subject: [PATCH 5/9] Completely remodeled issue template for simplicity and issue routing --- .github/ISSUE_TEMPLATE.md | 97 ++++++++------------------------------- 1 file changed, 20 insertions(+), 77 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 098a5b42..c91995cf 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,98 +1,41 @@ --- name: Playground Tools issues - wp-now, VS Code extension, utilities about: Did a tool not work the way you want it to? Let us know! -title: Report an issue in the Playground Tools repo +title: Report an issue with the Playground Tools labels: bug assignees: '' --- -## First make sure that you search for related issues in the `Playground Tools` repo's [issues](https://github.com/WordPress/playground-tools/issues) - -if not found... use whatever sections you want below to describe your issue. - -## Describe the issue -Please provide a clear and concise description, including step by step instructions to get to the error case you have found. This will include providing info on the configuring, tool, and environmental information. - -## To reproduce behavior -Steps to reproduce the behavior: -1. Enter the tool you are using, and context -2. What mode did you boot Playground in? -3. What specifically were you attempting to do? -4. Show errors from development environment and what you see on the Playground instance - -**Expected behavior** -A clear and concise description of what you expected to happen. - -## Blueprint or no? -Did you send a custom blueprint to the instance, or just boot up as-is? -## What protocol is used with the blueprint? -Query API: https://wordpress.github.io/wordpress-playground/apis-overview#query-api -JavaScript API: https://wordpress.github.io/wordpress-playground/apis-overview#javascript-api -PR Previewer - Look in `./testing/PROP.md` for more info - -## paste blueprint as `JSON` code below -The best practice is to copy directly from the code editor, this will retain formatting and readibility in most cases. - -If there are formatting issues, you can use a `JSON` code formatter like https://jsonformatter.org/ -Please copy/paste your blueprint from a code editor, which will retain spacing - -Once copy pasted below, you can delete all of these instructions. -It should be just the the `JSON` code directly below the bold sub-section above. - -If you chose **No** above - you did not have a blueprint... -Please delete the entire previous section to help keep the issue clean. +## Describe the bug you found -## Screenshots or screen recording -If applicable, add screenshots to help explain your problem. + -**Hint:** To avoid showing your system information, use a tool like [Oh My Zsh!](https://ohmyz.sh/) to hide the folder directory structure if you don't want to send this info +## Relevant system & diagnostic information -It can be helpful to show the directory structure for certain issues, use your discretion here. + -## Error reporting -You can use the [Site Health](https://wordpress.org/documentation/article/site-health-screen/) screen to - - submit WordPress environment info - - submit local system info - -You can use the Playground menu to `Report error`, which will automaticlly send some information and submit to the `#playground-logs` Channel on Making WordPress Slack. - - -## Include Console errors - -Please include the error you see in the console in a code block. +## Did you use a Blueprint? + -## Environmental info -Please complete the following information - - OS: [e.g. `'nix'`, 'MacOS', 'Windows' or the exact platform build] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +## Any additional info? -**Additional context** -Add any other context about the problem here. + \ No newline at end of file From 6afdbddb58627d4c32a1bb88ed833817c450db9e Mon Sep 17 00:00:00 2001 From: Seth Miller Date: Thu, 25 Apr 2024 23:26:31 -0400 Subject: [PATCH 6/9] Added bit about screenshots, consolidated with additional info --- .github/ISSUE_TEMPLATE.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c91995cf..4ffe31c7 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -36,6 +36,8 @@ etc. -## Any additional info? +## Screenshots and additional info - \ No newline at end of file + \ No newline at end of file From ff92f40a7486db0c69f1cf498c2f7020340ab467 Mon Sep 17 00:00:00 2001 From: Seth Miller Date: Thu, 25 Apr 2024 23:29:39 -0400 Subject: [PATCH 7/9] Formatting pass - hopefully G2G --- .github/ISSUE_TEMPLATE.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 4ffe31c7..6343585b 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -38,6 +38,4 @@ etc. ## Screenshots and additional info - \ No newline at end of file + \ No newline at end of file From 2a16d59f7c945c0453d8e2e15d3ec5213b904e0f Mon Sep 17 00:00:00 2001 From: Seth Miller Date: Sat, 27 Apr 2024 18:03:41 -0400 Subject: [PATCH 8/9] Removed multi-line guidance - streamlined into one line --- .github/ISSUE_TEMPLATE.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 6343585b..28bda498 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -11,18 +11,9 @@ assignees: '' Report issues with online Playground instances [here.](https://github.com/WordPress/wordpress-playground/issues) --> -## How are you using the Playground? +## Which Playground tool did you experience an issue with? - + ## Describe the bug you found From 07a7a0005295d4ecc9cdaf73feac0d1d78690fae Mon Sep 17 00:00:00 2001 From: Seth Miller Date: Mon, 20 May 2024 21:12:47 -0400 Subject: [PATCH 9/9] Update name and description MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adam Zieliński --- .github/ISSUE_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 28bda498..9fe40e3c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,6 +1,6 @@ --- -name: Playground Tools issues - wp-now, VS Code extension, utilities -about: Did a tool not work the way you want it to? Let us know! +name: Bug report +about: Report a bug with Playground tools, e.g. wp-now, VS Code extension, Playground block, Playground plugin title: Report an issue with the Playground Tools labels: bug assignees: ''