Skip to content
This repository was archived by the owner on Mar 17, 2025. It is now read-only.

Commit f5e3c38

Browse files
Jacob WengerChris Raynor
authored andcommitted
Added GitHub templates and rearranged README (#68)
1 parent 13a2e57 commit f5e3c38

File tree

9 files changed

+767
-525
lines changed

9 files changed

+767
-525
lines changed

.github/CONTRIBUTING.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Contributing | Firebase Queue
2+
3+
Thank you for contributing to the Firebase community!
4+
5+
- [Have a usage question?](#question)
6+
- [Think you found a bug?](#issue)
7+
- [Have a feature request?](#feature)
8+
- [Want to submit a pull request?](#submit)
9+
- [Need to get set up locally?](#local-setup)
10+
11+
12+
## <a name="question"></a>Have a usage question?
13+
14+
We get lots of those and we love helping you, but GitHub is not the best place for them. Issues
15+
which just ask about usage will be closed.
16+
17+
Start with the [guide](../docs/guide.md). If the official documentation doesn't help, try asking a
18+
question through our [official support channels](https://firebase.google.com/support/).
19+
20+
**Please avoid double posting across multiple channels!**
21+
22+
23+
## <a name="issue"></a>Think you found a bug?
24+
25+
Yeah, we're definitely not perfect!
26+
27+
Search through [old issues](https://github.com/firebase/firebase-queue/issues) before submitting a new
28+
issue as your question may have already been answered.
29+
30+
If your issue appears to be a bug, and hasn't been reported,
31+
[open a new issue](https://github.com/firebase/firebase-queue/issues/new). Please use the provided bug
32+
report template and include a minimal repro.
33+
34+
If you are up to the challenge, [submit a pull request](#submit) with a fix!
35+
36+
37+
## <a name="feature"></a>Have a feature request?
38+
39+
Great, we love hearing how we can improve our products! After making sure someone hasn't already
40+
requested the feature in the [existing issues](https://github.com/firebase/firebase-queue/issues), go
41+
ahead and [open a new issue](https://github.com/firebase/firebase-queue/issues/new). Feel free to remove
42+
the bug report template and instead provide an explanation of your feature request. Provide code
43+
samples if applicable. Try to think about what it will allow you to do that you can't do today? How
44+
will it make current workarounds straightforward? What potential bugs and edge cases does it help to
45+
avoid?
46+
47+
48+
## <a name="submit"></a>Want to submit a pull request?
49+
50+
Sweet, we'd love to accept your contribution! [Open a new pull request](https://github.com/firebase/firebase-queue/pull/new/master)
51+
and fill out the provided form.
52+
53+
**If you want to implement a new feature, please open an issue with a proposal first so that we can
54+
figure out if the feature makes sense and how it will work.**
55+
56+
Make sure your changes pass our linter and the tests all pass on your local machine. We've hooked
57+
up this repo with continuous integration to double check those things for you.
58+
59+
Most non-trivial changes should include some extra test coverage. If you aren't sure how to add
60+
tests, feel free to submit regardless and ask us for some advice.
61+
62+
Finally, you will need to sign our [Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
63+
before we can accept your pull request.
64+
65+
66+
## <a name="local-setup"></a>Need to get set up locally?
67+
68+
If you'd like to contribute to Firebase Queue, you'll need to do the following to get your
69+
environment set up.
70+
71+
### Install Dependencies
72+
73+
```bash
74+
$ git clone https://github.com/firebase/firebase-queue.git
75+
$ cd firebase-queue # go to the firebase-queue directory
76+
$ npm install -g gulp # globally install gulp task runner
77+
$ npm install # install local npm build / test dependencies
78+
```
79+
80+
### Create a Firebase Project
81+
82+
1. Create a Firebase project [here](https://console.firebase.google.com).
83+
2. Set the `FB_QUEUE_TEST_DB_URL` environment variable to your project's database URL:
84+
85+
```bash
86+
$ export FB_QUEUE_TEST_DB_URL="https://<YOUR-DATABASE-NAME>.firebaseio.com"
87+
```
88+
89+
### Download a Service Account JSON File
90+
91+
1. Follow the instructions [here](https://firebase.google.com/docs/server/setup#add_firebase_to_your_app)
92+
on how to create a service account for your project and furnish a private key.
93+
2. Copy the credentials JSON file to `test/key.json`.
94+
95+
### Lint, Build, and Test
96+
97+
```bash
98+
$ gulp # lint, build, and test
99+
100+
$ gulp lint # just lint
101+
$ gulp build # just build
102+
$ gulp test # just test
103+
```

.github/ISSUE_TEMPLATE.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!--
2+
3+
Thank you for contributing to the Firebase community!
4+
5+
Have a usage question?
6+
=======================
7+
We get lots of those and we love helping you, but GitHub is not the best place for them and they
8+
will be closed.
9+
10+
Start with the guide: https://github.com/firebase/firebase-queue/blob/master/docs/guide.md
11+
12+
If the official documentation doesn't help, try asking through our official support channels:
13+
14+
https://firebase.google.com/support/
15+
16+
*Please avoid double posting across multiple channels!*
17+
18+
Think you found a bug?
19+
=======================
20+
Yeah, we're definitely not perfect! Please use the bug report template below and include a minimal
21+
repro when opening the issue.
22+
23+
24+
Have a feature request?
25+
========================
26+
Great, we love hearing how we can improve our products! Just remove the template below and
27+
provide an explanation of your feature request. Provide code samples if applicable. Try to
28+
think about what it will allow you to do that you can't do today? How will it make current
29+
workarounds straightforward? What potential bugs and edge cases does it help to avoid?
30+
31+
-->
32+
33+
34+
### Version info
35+
36+
<!-- What versions of the following libraries are you using? Note that your issue may already
37+
be fixed in the latest versions. -->
38+
39+
**Firebase:**
40+
41+
**Firebase Queue:**
42+
43+
**Node.js:**
44+
45+
**Other (e.g. operating system) (if applicable):**
46+
47+
### Test case
48+
49+
<!-- Provide a minimal, complete, and verifiable example (http://stackoverflow.com/help/mcve)
50+
using either Plunker (http://plnkr.co/) or JSFiddle (https://jsfiddle.net/). -->
51+
52+
53+
### Steps to reproduce
54+
55+
<!-- Provide the steps needed to reproduce the issue given the above test case. -->
56+
57+
58+
### Expected behavior
59+
60+
<!-- What is the expected behavior? -->
61+
62+
63+
### Actual behavior
64+
65+
<!-- What is the actual behavior? -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--
2+
3+
Thank you for contributing to the Firebase community! Please fill out the pull request form below
4+
and make note of the following:
5+
6+
Run the linter and test suite
7+
==============================
8+
Make sure your changes pass our linter and the tests all pass on your local machine. We've hooked
9+
up this repo with continuous integration to double check those things for you.
10+
11+
Add tests (if applicable)
12+
==============================
13+
Most non-trivial changes should include some extra test coverage. If you aren't sure how to add
14+
tests, feel free to submit regardless and ask us for some advice.
15+
16+
Sign our CLA
17+
==============================
18+
Please sign our Contributor License Agreement (https://cla.developers.google.com/about/google-individual)
19+
before sending PRs. We cannot accept code without this.
20+
21+
-->
22+
23+
24+
### Description
25+
26+
<!-- Are you fixing a bug? Updating our documentation? Implementing a new feature? Make sure we
27+
have the context around your change. Link to other relevant issues or pull requests. -->
28+
29+
### Code sample
30+
31+
<!-- Proposing an API change? Provide code samples showing how the API will be used. -->

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ dist/
66
coverage/
77
node_modules/
88

9-
key.json
9+
test/key.json

.travis.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ node_js:
66
- '5'
77
- stable
88
sudo: false
9+
env:
10+
FB_QUEUE_TEST_DB_URL=https://fir-queue-test.firebaseio.com
911
install:
1012
- npm install
1113
script:
12-
- '[ -e key.json ] && npm run travis || false'
14+
- '[ -e test/key.json ] && npm run travis || false'
1315
after_script:
1416
- cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
1517
before_install:
1618
- openssl aes-256-cbc -K $encrypted_a237b3635f54_key -iv $encrypted_a237b3635f54_iv
17-
-in key.json.enc -out key.json -d
19+
-in test/key.json.enc -out test/key.json -d

0 commit comments

Comments
 (0)