docs: Updating issue templates to new format #1474
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
rschristian
force-pushed
the
docs/issueTemplates
branch
from
2d42fd5
to
30306af
Compare
ForsakenHarmony
approved these changes
Mar 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
An update to the issue templates
Did you add tests for your changes?
N/A
Summary
I noticed our issue template was a bit behind as it asks users to run
preact infothough for a while we've suggested interacting with Preact-CLI on a global level via NPX. This has lead to a few issues where users mention that this is not a command or that they want to provide the information but don't know how. This isn't optimal.When I went to take a glance at the templates I was met with the following message:
You are using an old version of issue templates. Please update to the new issue template workflow.Learn moreAfter reading through the docs I created these new templates with the correct info command (
npx preact info). The templates are a mix between the existing and GH's own templates. I split the existing template so users now just choose to either use the Bug Report template or the Feature Request template which is a nice convenience thing.Certainly let me know if I should change the verbiage anywhere. This could also be an opportunity to more heavily recommend something like CodeSandbox over a GitHub Gist in the bug reports if that's something that others see as preferable. Just a thought.
Does this PR introduce a breaking change?
Nope