22
33Thank you for contributing to the Firebase community!
44
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-
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 )
1110
1211## <a name =" question " ></a >Have a usage question?
1312
1413We get lots of those and we love helping you, but GitHub is not the best place for them. Issues
1514which just ask about usage will be closed. Here are some resources to get help:
1615
1716- Start with the [ quickstart] ( ../docs/quickstart.md )
18- - Go through the [ guide] ( ../docs/guide .md )
17+ - Go through the [ guide] ( ../docs/use .md )
1918- Read the full [ API reference] ( ../docs/reference.md )
20- - Try out some [ examples] ( ../examples/README.md )
2119
2220If the official documentation doesn't help, try asking a question through our
2321[ official support channels] ( https://firebase.google.com/support/ ) .
2422
2523** Please avoid double posting across multiple channels!**
2624
27-
2825## <a name =" issue " ></a >Think you found a bug?
2926
3027Yeah, we're definitely not perfect!
@@ -38,7 +35,6 @@ report template and include a minimal repro.
3835
3936If you are up to the challenge, [ submit a pull request] ( #submit ) with a fix!
4037
41-
4238## <a name =" feature " ></a >Have a feature request?
4339
4440Great, we love hearing how we can improve our products! After making sure someone hasn't already
@@ -49,7 +45,6 @@ samples if applicable. Try to think about what it will allow you to do that you
4945will it make current workarounds straightforward? What potential bugs and edge cases does it help to
5046avoid?
5147
52-
5348## <a name =" submit " ></a >Want to submit a pull request?
5449
5550Sweet, we'd love to accept your contribution! [ Open a new pull request] ( https://github.com/firebase/reactfire/pull/new/master )
@@ -67,33 +62,31 @@ tests, feel free to submit regardless and ask us for some advice.
6762Finally, you will need to sign our [ Contributor License Agreement] ( https://cla.developers.google.com/about/google-individual )
6863before we can accept your pull request.
6964
70-
7165## <a name =" local-setup " ></a >Need to get set up locally?
7266
7367If you'd like to contribute to ReactFire, you'll need to do the following to get your environment
7468set up.
7569
76- ### Install Dependencies
70+ ### For development
7771
78- ``` bash
79- $ git clone https://github.com/firebase/reactfire.git
80- $ cd reactfire # go to the reactfire directory
81- $ npm install -g gulp # globally install gulp task runner
82- $ npm install -g bower # globally install Bower package manager
83- $ npm install # install local npm build / test dependencies
84- $ bower install # install local JavaScript dependencies
85- ```
72+ 1 . [ Clone] ( https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository )
73+ this repository (or a
74+ [ fork] ( https://help.github.com/en/github/getting-started-with-github/fork-a-repo#propose-changes-to-someone-elses-project ) )
75+ 1 . At the project root, install all modules by running ` yarn install ` .
76+ 1 . ` cd ` into the _ reactfire_ directory. Run ` yarn ` and ` yarn watch ` .
77+ 1 . In a new terminal, ` cd ` into the _ reactfire/sample_ directory. run ` yarn ` and
78+ ` yarn start ` .
79+ 1 . Head over to https://localhost:3000 to see the running sample! If you edit
80+ the reactfire source, the sample will reload.
8681
87- ### Lint, Build, and Test
82+ ### Testing
8883
89- ``` bash
90- $ gulp # lint, build, and test
84+ 1 . ` cd ` into the _ reactfire/reactfire _ directory
85+ 1 . run ` yarn test`
9186
92- $ gulp lint # just lint
93- $ gulp build # just build
94- $ gulp test # just test
87+ ### Bulding
9588
96- $ gulp watch # lint and build whenever source files change
97- `` `
89+ 1 . ` cd ` into the _ reactfire/reactfire _ directory
90+ 1 . run ` yarn build `
9891
9992The output files - ` reactfire.js ` and ` reactfire.min.js ` - are written to the ` /dist/ ` directory.
0 commit comments