Contributing | ReactFire

Thank you for contributing to the Firebase community!

Have a usage question?
Think you found a bug?
Have a feature request?
Want to submit a pull request?
Need to get set up locally?

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
Go through the guide
Read the full API reference

If the official documentation doesn't help, try asking a question through our official support channels.

Please avoid double posting across multiple channels!

Think you found a bug?

Yeah, we're definitely not perfect!

Search through old 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. Please use the provided bug report template and include a minimal repro.

If you are up to the challenge, submit a pull request with a fix!

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, go ahead and open a new issue. 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?

Want to submit a pull request?

Sweet, we'd love to accept your contribution! Open a new pull request 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 before we can accept your pull request.

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.

For development

Clone this repository (or a fork)
At the project root, install all modules by running yarn install.
cd into the reactfire directory. Run yarn and yarn watch.
In a new terminal, cd into the reactfire/sample directory. run yarn and yarn start.
Head over to https://localhost:3000 to see the running sample! If you edit the reactfire source, the sample will reload.

Testing

cd into the reactfire/reactfire directory
run yarn test

Bulding

cd into the reactfire/reactfire directory
run yarn build

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

3.9 KiB Raw Permalink Blame History