search

FirebaseExtended / reactfire

Hooks, Context Providers, and Components that make it easy to interact with Firebase.
https://firebaseopensource.com/projects/firebaseextended/reactfire/
MIT License
3.52k stars 401 forks source link

update CONTRIBUTING.md #439

Closed jhuleatt closed 3 years ago

jhuleatt commented 3 years ago

Add instructions to run:

yarn build
yarn test
yarn lint
yarn docs

before committing

justjish commented 3 years ago

Might want to clarify that forked repos typically require the following to be added to the typedoc args --gitRemote upstream

so in full it would be typedoc --options typedoc.json --gitRemote upstream && markdown-toc -i docs/use.md

jhuleatt commented 3 years ago

Might want to clarify that forked repos typically require the following to be added to the typedoc args --gitRemote upstream

so in full it would be typedoc --options typedoc.json --gitRemote upstream && markdown-toc -i docs/use.md

Great point, I've added a new yarn docs:fork command and added it to the Before submitting a PR instructions.