@@ -17,8 +17,7 @@ which just ask about usage will be closed. Here are some resources to get help:
1717- Go through the [ guide] ( ../docs/use.md )
1818- Read the full [ API reference] ( ../docs/reference )
1919
20- If the official documentation doesn't help, try asking a question through our
21- [ official support channels] ( https://firebase.google.com/support/ ) .
20+ If the official documentation doesn't help, try starting a [ discussion] ( https://github.com/FirebaseExtended/reactfire/discussions ) .
2221
2322** Please avoid double posting across multiple channels!**
2423
@@ -73,20 +72,15 @@ set up.
7372 this repository (or a
7473 [ fork] ( https://help.github.com/en/github/getting-started-with-github/fork-a-repo#propose-changes-to-someone-elses-project ) )
75741 . 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.
75+ 1 . Start a dev build of reactfire by running ` yarn start ` . ReactFire will recompile on every file change.
8176
8277### Testing
8378
84- 1 . ` cd ` into the _ reactfire/reactfire_ directory
85- 1 . run ` yarn test `
79+ 1 . run ` yarn test ` from the repository root. Make sure you've rebuilt your changes (usually by keeping ` yarn start ` running in a separate tab).
8680
87- ### Bulding
81+ ### Before submitting a PR
8882
89- 1 . ` cd ` into the _ reactfire/reactfire _ directory
90- 1 . run ` yarn build `
91-
92- The output files - ` reactfire.js ` and ` reactfire.min.js ` - are written to the ` /dist/ ` directory.
83+ 1 . run ` yarn build ` to confirm that the source builds
84+ 2 . run ` yarn test ` to confirm that tests pass
85+ 3 . run ` yarn lint ` to confirm that code meets our style guide
86+ 4 . run ` yarn docs ` to rebuild the reference docs
0 commit comments