Skip to content

Commit 971b29e

Browse files
katowulfdavideast
authored andcommitted
chore(docs): Improve wording of issue template (#626)
* docs: Improve wording of issue template Encourage better minimal repros by improving the wording of our issue template. * docs: add note that issue template is required.
1 parent 892ecd4 commit 971b29e

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

ISSUE_TEMPLATE.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<!--
22
3+
IMPORTANT! YOU MUST FOLLOW THESE INSTRUCTIONS OR YOUR ISSUE WILL BE CLOSED.
4+
35
Thank you for contributing to the Firebase community!
46
57
Have a usage question?
@@ -24,10 +26,9 @@ Think you found a bug?
2426
Yeah, we're definitely not perfect! Please use the bug report template below and include a minimal
2527
repro when opening the issue.
2628
27-
2829
Have a feature request?
2930
========================
30-
Great, we love hearing how we can improve our products! Just remove the template below and
31+
Great, we love hearing how we can improve our products! Remove the template below and
3132
provide an explanation of your feature request. Provide code samples if applicable. Try to
3233
think about what it will allow you to do that you can't do today? How will it make current
3334
workarounds straightforward? What potential bugs and edge cases does it help to avoid?
@@ -46,13 +47,25 @@ be fixed in the latest versions. -->
4647

4748
**AngularFire:**
4849

49-
**Other (e.g. Node, browser, operating system) (if applicable):**
50+
**Other (e.g. Ionic/Cordova, Node, browser, operating system):**
51+
52+
### How to reproduce these conditions
5053

51-
### Test case
54+
**Failing test unit, Plunkr, or JSFiddle demonstrating the problem**
5255

53-
<!-- Provide a failing test unit, or create a minimal, complete, and
56+
<!--
57+
Provide a failing test unit, or create a minimal, complete, and
5458
verifiable example (http://stackoverflow.com/help/mcve) using either
55-
Plunker (http://plnkr.co/) or JSFiddle (https://jsfiddle.net/). -->
59+
Plunker (http://plnkr.co/) or JSFiddle (https://jsfiddle.net/).
60+
-->
61+
62+
**Steps to set up and reproduce**
63+
64+
<!-- detailed instructions to run your minimal repro or to recreate the environment -->
65+
66+
**Sample data and security rules**
67+
68+
<-- include/attach/link to some json sample data (or provide credentials to a sanitized, test Firebase project) -->
5669

5770
### Debug output
5871

@@ -62,16 +75,10 @@ Plunker (http://plnkr.co/) or JSFiddle (https://jsfiddle.net/). -->
6275

6376
** Screenshots **
6477

65-
### Steps to reproduce
66-
67-
<!-- Provide the steps needed to reproduce the issue given the above test case. -->
68-
69-
7078
### Expected behavior
7179

7280
<!-- What is the expected behavior? -->
7381

74-
7582
### Actual behavior
7683

77-
<!-- What is the actual behavior? -->
84+
<!-- What is the actual behavior? -->

0 commit comments

Comments
 (0)