Skip to content

Commit 0de3814

Browse files
authored
Update issue templates (#621)
* Update issue templates * Using the new GitHub recommended issue template flow * Introducing a new issue template for Firestore issues * Removed old issue template * Updated firestore template * Added snippet for enabling Firestore logs
1 parent d05dd23 commit 0de3814

File tree

4 files changed

+131
-4
lines changed

4 files changed

+131
-4
lines changed

ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
110
### [READ] Step 1: Are you in the right place?
211

3-
* For issues or feature requests related to __the code in this repository__
4-
file a Github issue.
5-
* If this is a __feature request__ make sure the issue title starts with "FR:".
12+
* For issues related to __the code in this repository__ file a Github issue.
613
* For general technical questions, post a question on [StackOverflow](http://stackoverflow.com/)
714
with the firebase tag.
815
* For general Firebase discussion, use the [firebase-talk](https://groups.google.com/forum/#!forum/firebase-talk)
@@ -15,8 +22,9 @@
1522

1623
* Operating System version: _____
1724
* Firebase SDK version: _____
18-
* Library version: _____
1925
* Firebase Product: _____ (auth, database, storage, etc)
26+
* Node.js version: _____
27+
* NPM version: _____
2028

2129
### [REQUIRED] Step 3: Describe the problem
2230

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FR]"
5+
labels: 'type: feature request'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context, code samples or screenshots about the feature request here.
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: Firestore issue
3+
about: Bug reports and feature requests related to Cloud Firestore
4+
title: "[Firestore]"
5+
labels: 'api: firestore'
6+
assignees: schmidt-sebastian
7+
8+
---
9+
10+
### [READ] Step 1: Are you in the right place?
11+
12+
**Cloud Firestore support is provided by the
13+
[`@google-cloud/firestore`](https://npmjs.com/package/@google-cloud/firestore) library.
14+
Therefore the easiest and most efficient way to get Firestore issues resolved
15+
is by directly reporting them at the
16+
[nodejs-firestore](https://github.com/googleapis/nodejs-firestore) GitHub repo.**
17+
18+
If you still think the problem is related to the code in this repository, then read on.
19+
20+
* For issues or feature requests related to __the code in this repository__
21+
file a Github issue.
22+
* For general technical questions, post a question on [StackOverflow](http://stackoverflow.com/)
23+
with the firebase tag.
24+
* For general Firebase discussion, use the [firebase-talk](https://groups.google.com/forum/#!forum/firebase-talk)
25+
google group.
26+
* For help troubleshooting your application that does not fall under one
27+
of the above categories, reach out to the personalized
28+
[Firebase support channel](https://firebase.google.com/support/).
29+
30+
### [REQUIRED] Step 2: Describe your environment
31+
32+
* Operating System version: _____
33+
* Firebase SDK version: _____
34+
* Firebase Product: Firestore
35+
* Node.js version: _____
36+
* NPM version: _____
37+
38+
### [REQUIRED] Step 3: Describe the problem
39+
40+
#### Steps to reproduce:
41+
42+
What happened? How can we make the problem occur?
43+
This could be a description, log/console output, etc.
44+
45+
You can enable logging for Firestore by including the following line in your code:
46+
47+
```
48+
admin.firestore.setLogFunction(console.log);
49+
```
50+
51+
This will print Firestore logs to the console.
52+
53+
#### Relevant Code:
54+
55+
```
56+
// TODO(you): code here to reproduce the problem
57+
```
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: General Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
### [READ] Step 1: Are you in the right place?
11+
12+
* For issues related to __the code in this repository__ file a Github issue.
13+
* If the issue pertains to Cloud Firestore, read the instructions in the "Firestore issue"
14+
template.
15+
* For general technical questions, post a question on [StackOverflow](http://stackoverflow.com/)
16+
with the firebase tag.
17+
* For general Firebase discussion, use the [firebase-talk](https://groups.google.com/forum/#!forum/firebase-talk)
18+
google group.
19+
* For help troubleshooting your application that does not fall under one
20+
of the above categories, reach out to the personalized
21+
[Firebase support channel](https://firebase.google.com/support/).
22+
23+
### [REQUIRED] Step 2: Describe your environment
24+
25+
* Operating System version: _____
26+
* Firebase SDK version: _____
27+
* Firebase Product: _____ (auth, database, storage, etc)
28+
* Node.js version: _____
29+
* NPM version: _____
30+
31+
### [REQUIRED] Step 3: Describe the problem
32+
33+
#### Steps to reproduce:
34+
35+
What happened? How can we make the problem occur?
36+
This could be a description, log/console output, etc.
37+
38+
#### Relevant Code:
39+
40+
```
41+
// TODO(you): code here to reproduce the problem
42+
```

0 commit comments

Comments
 (0)