Skip to content

Commit

Permalink
Added GitHub templates and rearranged README (#68)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jacob Wenger authored and Chris Raynor committed May 27, 2016
1 parent 13a2e57 commit f5e3c38
Show file tree
Hide file tree
Showing 9 changed files with 767 additions and 525 deletions.
103 changes: 103 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Contributing | Firebase Queue

Thank you for contributing to the Firebase community!

- [Have a usage question?](#question)
- [Think you found a bug?](#issue)
- [Have a feature request?](#feature)
- [Want to submit a pull request?](#submit)
- [Need to get set up locally?](#local-setup)


## <a name="question"></a>Have a usage question?

We get lots of those and we love helping you, but GitHub is not the best place for them. Issues
which just ask about usage will be closed.

Start with the [guide](../docs/guide.md). If the official documentation doesn't help, try asking a
question through our [official support channels](https://firebase.google.com/support/).

**Please avoid double posting across multiple channels!**


## <a name="issue"></a>Think you found a bug?

Yeah, we're definitely not perfect!

Search through [old issues](https://github.com/firebase/firebase-queue/issues) before submitting a new
issue as your question may have already been answered.

If your issue appears to be a bug, and hasn't been reported,
[open a new issue](https://github.com/firebase/firebase-queue/issues/new). Please use the provided bug
report template and include a minimal repro.

If you are up to the challenge, [submit a pull request](#submit) with a fix!


## <a name="feature"></a>Have a feature request?

Great, we love hearing how we can improve our products! After making sure someone hasn't already
requested the feature in the [existing issues](https://github.com/firebase/firebase-queue/issues), go
ahead and [open a new issue](https://github.com/firebase/firebase-queue/issues/new). Feel free to remove
the bug report template and instead provide an explanation of your feature request. Provide code
samples if applicable. Try to think about what it will allow you to do that you can't do today? How
will it make current workarounds straightforward? What potential bugs and edge cases does it help to
avoid?


## <a name="submit"></a>Want to submit a pull request?

Sweet, we'd love to accept your contribution! [Open a new pull request](https://github.com/firebase/firebase-queue/pull/new/master)
and fill out the provided form.

**If you want to implement a new feature, please open an issue with a proposal first so that we can
figure out if the feature makes sense and how it will work.**

Make sure your changes pass our linter and the tests all pass on your local machine. We've hooked
up this repo with continuous integration to double check those things for you.

Most non-trivial changes should include some extra test coverage. If you aren't sure how to add
tests, feel free to submit regardless and ask us for some advice.

Finally, you will need to sign our [Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
before we can accept your pull request.


## <a name="local-setup"></a>Need to get set up locally?

If you'd like to contribute to Firebase Queue, you'll need to do the following to get your
environment set up.

### Install Dependencies

```bash
$ git clone https://github.com/firebase/firebase-queue.git
$ cd firebase-queue # go to the firebase-queue directory
$ npm install -g gulp # globally install gulp task runner
$ npm install # install local npm build / test dependencies
```

### Create a Firebase Project

1. Create a Firebase project [here](https://console.firebase.google.com).
2. Set the `FB_QUEUE_TEST_DB_URL` environment variable to your project's database URL:

```bash
$ export FB_QUEUE_TEST_DB_URL="https://<YOUR-DATABASE-NAME>.firebaseio.com"
```

### Download a Service Account JSON File

1. Follow the instructions [here](https://firebase.google.com/docs/server/setup#add_firebase_to_your_app)
on how to create a service account for your project and furnish a private key.
2. Copy the credentials JSON file to `test/key.json`.

### Lint, Build, and Test

```bash
$ gulp # lint, build, and test

$ gulp lint # just lint
$ gulp build # just build
$ gulp test # just test
```
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<!--
Thank you for contributing to the Firebase community!
Have a usage question?
=======================
We get lots of those and we love helping you, but GitHub is not the best place for them and they
will be closed.
Start with the guide: https://github.com/firebase/firebase-queue/blob/master/docs/guide.md
If the official documentation doesn't help, try asking through our official support channels:
https://firebase.google.com/support/
*Please avoid double posting across multiple channels!*
Think you found a bug?
=======================
Yeah, we're definitely not perfect! Please use the bug report template below and include a minimal
repro when opening the issue.
Have a feature request?
========================
Great, we love hearing how we can improve our products! Just remove the template below and
provide an explanation of your feature request. Provide code samples if applicable. Try to
think about what it will allow you to do that you can't do today? How will it make current
workarounds straightforward? What potential bugs and edge cases does it help to avoid?
-->


### Version info

<!-- What versions of the following libraries are you using? Note that your issue may already
be fixed in the latest versions. -->

**Firebase:**

**Firebase Queue:**

**Node.js:**

**Other (e.g. operating system) (if applicable):**

### Test case

<!-- Provide a minimal, complete, and verifiable example (http://stackoverflow.com/help/mcve)
using either Plunker (http://plnkr.co/) or JSFiddle (https://jsfiddle.net/). -->


### Steps to reproduce

<!-- Provide the steps needed to reproduce the issue given the above test case. -->


### Expected behavior

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


### Actual behavior

<!-- What is the actual behavior? -->
31 changes: 31 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!--
Thank you for contributing to the Firebase community! Please fill out the pull request form below
and make note of the following:
Run the linter and test suite
==============================
Make sure your changes pass our linter and the tests all pass on your local machine. We've hooked
up this repo with continuous integration to double check those things for you.
Add tests (if applicable)
==============================
Most non-trivial changes should include some extra test coverage. If you aren't sure how to add
tests, feel free to submit regardless and ask us for some advice.
Sign our CLA
==============================
Please sign our Contributor License Agreement (https://cla.developers.google.com/about/google-individual)
before sending PRs. We cannot accept code without this.
-->


### Description

<!-- Are you fixing a bug? Updating our documentation? Implementing a new feature? Make sure we
have the context around your change. Link to other relevant issues or pull requests. -->

### Code sample

<!-- Proposing an API change? Provide code samples showing how the API will be used. -->
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ dist/
coverage/
node_modules/

key.json
test/key.json
6 changes: 4 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ node_js:
- '5'
- stable
sudo: false
env:
FB_QUEUE_TEST_DB_URL=https://fir-queue-test.firebaseio.com
install:
- npm install
script:
- '[ -e key.json ] && npm run travis || false'
- '[ -e test/key.json ] && npm run travis || false'
after_script:
- cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
before_install:
- openssl aes-256-cbc -K $encrypted_a237b3635f54_key -iv $encrypted_a237b3635f54_iv
-in key.json.enc -out key.json -d
-in test/key.json.enc -out test/key.json -d
Loading

0 comments on commit f5e3c38

Please sign in to comment.