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

Add Playground Tools issue templates #236

Open
wants to merge 9 commits into
base: trunk
Choose a base branch
from

Conversation

flexseth
Copy link

@flexseth flexseth commented Apr 17, 2024

What?

Adds issue template starting point for Playground Tools

Why?

Creates guidelines for better error reporting

How?

Creating an issue template

Testing Instructions

  1. Allow issue templates on the
    Playground Tools repo
  2. Check or merge PR
  3. Open a new issue and use the Playground Tools issues - wp-now, VS Code extension, utilities template
  4. See if it suits the needs or needs updating

Copy link
Author

@flexseth flexseth left a comment

Choose a reason for hiding this comment

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

@adamziel - if you can please review this PR to add an issues template for error reporting, it may be improved when more of the known issues docs come online.

For now, it can set the stage for some info we'd like to collect when reporting errors.

It's a little less detailed than the Playground online issue template, because the end users is assumed to be a little more advanced.

And link to Site Health screen
Made it to where they can optionally include what they want
Copy link
Author

@flexseth flexseth left a comment

Choose a reason for hiding this comment

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

Please take a look at this and let me know what you think, @adamziel

@flexseth flexseth requested a review from adamziel April 26, 2024 02:50
.github/ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
Copy link
Author

@flexseth flexseth left a comment

Choose a reason for hiding this comment

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

changes made per request

@flexseth flexseth requested a review from adamziel April 27, 2024 22:05
@ironnysh
Copy link
Contributor

ironnysh commented May 5, 2024

Suggestion: add a GitHub workflow to auto-label issues when submitting (see example on WordPress Learn)

@adamziel
Copy link
Collaborator

Shouldn't this be a .yml file living in .github/ISSUE_TEMPLATE? Or will it work as a .md file living in .github?

@flexseth
Copy link
Author

It depends how it was created, I'll have to go back through the workflow to figure out how it should be named

@flexseth
Copy link
Author

flexseth commented May 14, 2024

Shouldn't this be a .yml file living in .github/ISSUE_TEMPLATE? Or will it work as a .md file living in .github?

TLDR; It'll work as submitted :)


The way I created it (screen flow attached) - used the Markdown issue syntax.

issue.templates.flow.mov

Looks like it can be either. 

Advanced issue templates

For more advanced issue flows, utilizing GitHub Actions etc - you can provide additional metadata via YAML. This can help with automatically labeling or assigning issues, and allows additional markup options (more similar to HTML input)

YAML syntax for issue templates

Advancing the PR

Want to start with Markdown and see if the YAML implementation provides more value, via automation, in the future?

@flexseth
Copy link
Author

Suggestion: add a GitHub workflow to auto-label issues when submitting (see example on WordPress Learn)

Awaiting feedback about implementing automated workflows, or starting out with a basic issue template

Here's the PR though!

.github/ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
Co-authored-by: Adam Zieliński <[email protected]>
Copy link
Author

@flexseth flexseth left a comment

Choose a reason for hiding this comment

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

@adamziel - this should be it!!

@flexseth flexseth changed the title Added Playground Tools issue templates Add Playground Tools issue templates May 21, 2024
@flexseth flexseth requested a review from adamziel May 23, 2024 20:10
@flexseth
Copy link
Author

Shouldn't this be a .yml file living in .github/ISSUE_TEMPLATE? Or will it work as a .md file living in .github?

It's throwing a warning on the Playground Tools (this) issue template.


Screenshot

image

Strangely, I don't see the same notice on the primary Playground repo issues template

Want me to figure it out?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants