Skip to content

Commit

Permalink
Less passive-aggressive issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
gaearon authored Jun 27, 2017
1 parent 5474e2d commit 0b6c7ff
Showing 1 changed file with 31 additions and 25 deletions.
56 changes: 31 additions & 25 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
PLEASE DON'T DELETE THIS TEMPLATE UNTIL YOU HAVE READ THE FIRST SECTION.
PLEASE READ THE FIRST SECTION :-)
-->

### Is this a bug report?
Expand All @@ -8,18 +8,20 @@

<!--
If you answered "Yes":
Please note that your issue will be fixed much faster if you spend about
half an hour preparing it, including the exact reproduction steps and a demo.
If you're in a hurry or don't feel confident, it's fine to report bugs with
less details, but this makes it less likely they'll get fixed soon.
We expect that it will take you about 30 minutes to produce a high-quality bug report.
While this may seem like a lot, putting care into issues helps us fix them faster.
For bug reports, it is REQUIRED to fill the rest of this template, or the issue will be closed.
In either case, please fill as many fields below as you can.
If you answered "No":
If this is a question or a discussion, you may delete this template and write in a free form.
Note that we don't provide help for webpack questions after ejecting.
You can find webpack docs at https://webpack.js.org/.
Now scroll below!
-->


Expand All @@ -42,25 +44,30 @@
Then try to reproduce the issue again.
Can you still reproduce it?
Note: Please try this even if you are using Yarn. Yarn also has bugs.
Note: Please try this even if you are using Yarn so that we know whether it's a Yarn-only bug.
-->

(Write your answer here.)


### Have you read the Troubleshooting section and searched the User Guide?
### Which terms did you search for in User Guide?

<!--
There are a few common documented problems, such as watcher not detecting changes.
There are a few common documented problems, such as watcher not detecting changes, or build failing.
They are described in the Troubleshooting section of the User Guide:
https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#troubleshooting
Have you read that section, and have you searched the User Guide for symptoms of your problem?
Please write the answer below:
Please scan these few sections for common problems.
Additionally, you can search the User Guide itself for something you're having issues with:
https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.me
If you didn't find the solution, please share which words you searched for.
This helps us improve documentation for future readers who might encounter the same problem.
-->

(Write the terms you searched for on the User Guide page.)
(Write your answer here if relevant.)


### Environment
Expand Down Expand Up @@ -110,16 +117,18 @@ Then, specify:
<!--
Did something go wrong?
Is something broken, or not behaving as you expected?
Describe this section in detail, and attach screenshots if possible.
Please attach screenshots if possible! They are extremely helpful for diagnosing issues.
-->

(Write what happened. Add screenshots!)
(Write what happened. Please add screenshots!)


### Reproducible Demo

<!--
Please share a project that reproduces the issue.
If you can, please share a project that reproduces the issue.
This is the single most effective way to get an issue fixed soon.
There are two ways to do it:
* Create a new app and try to reproduce the issue in it.
Expand All @@ -136,16 +145,13 @@ Then, specify:

<!--
What happens if you skip this step?
Someone will read your bug report, and maybe will be able to help you,
but it’s unlikely that it will get much attention from the team. Eventually,
the issue will likely get closed in favor of issues that have reproducible demos.
Please remember that:
* Issues without reproducible demos have a very low priority.
* The person fixing the bug would have to do that anyway. Please be respectful of their time.
* You might figure out the issues yourself as you work on extracting it.
We will try to help you, but in many cases it is impossible because crucial
information is missing. In that case we'll tag an issue as having a low priority,
and eventually close it if there is no clear direction.
We still appreciate the report though, as eventually somebody else might
create a reproducible example for it.
Thanks for helping us help you!
-->

1 comment on commit 0b6c7ff

@ashtonsix
Copy link
Contributor

@ashtonsix ashtonsix commented on 0b6c7ff Jun 27, 2017

Choose a reason for hiding this comment

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

Much better! This is what I was referring to in this tweet:

https://twitter.com/AshtonSix/status/879455590707232769

It's not passive-aggressive at all now, but could the NPM v4 section be clarified slightly? And could the "reproducible demo" section be merged with "steps to reproduce"?

I'm not so good with words but made a very small PR for another nit.

Please sign in to comment.