Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 22 additions & 29 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,26 @@

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)

- [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. Here are some resources to get help:

- Start with the [quickstart](../docs/quickstart.md)
- Go through the [guide](../docs/guide.md)
- Go through the [guide](../docs/use.md)
- Read the full [API reference](../docs/reference.md)
- Try out some [examples](../examples/README.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!
Expand All @@ -38,7 +35,6 @@ 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
Expand All @@ -49,7 +45,6 @@ samples if applicable. Try to think about what it will allow you to do that you
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/reactfire/pull/new/master)
Expand All @@ -67,33 +62,31 @@ 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 ReactFire, you'll need to do the following to get your environment
set up.

### Install Dependencies
### For development

```bash
$ git clone https://github.com/firebase/reactfire.git
$ cd reactfire # go to the reactfire directory
$ npm install -g gulp # globally install gulp task runner
$ npm install -g bower # globally install Bower package manager
$ npm install # install local npm build / test dependencies
$ bower install # install local JavaScript dependencies
```
1. [Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
this repository (or a
[fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo#propose-changes-to-someone-elses-project))
1. At the project root, install all modules by running `yarn install`.
1. `cd` into the _reactfire_ directory. Run `yarn` and `yarn watch`.
1. In a new terminal, `cd` into the _reactfire/sample_ directory. run `yarn` and
`yarn start`.
1. Head over to https://localhost:3000 to see the running sample! If you edit
the reactfire source, the sample will reload.

### Lint, Build, and Test
### Testing

```bash
$ gulp # lint, build, and test
1. `cd` into the _reactfire/reactfire_ directory
1. run `yarn test`

$ gulp lint # just lint
$ gulp build # just build
$ gulp test # just test
### Bulding

$ gulp watch # lint and build whenever source files change
```
1. `cd` into the _reactfire/reactfire_ directory
1. run `yarn build`

The output files - `reactfire.js` and `reactfire.min.js` - are written to the `/dist/` directory.