To contribute to this project, first:
- Fork this repo to your account
git clone https://github.com/[your-username]/react-hook.gitcd react-hook
Packages must be installed individually. They must also be installed using the yarn packager. An example for working on throttle:
cd packages/throttleyarn install
Each individual package includes the following scripts:
build: Builds cjs/esm, types, and umddev: Runs cjs and esm builds in--watchmodecheck-types: Checks TypeScript typesformat: Formats the package w/ Prettierlint: Lints the package w/ eslinttest: Tests the package w/ Jestvalidate: Tests, lints, and checks types for the package
Prior to submitting a pull request please ensure that:
yarn validatepasses- You've included a tag with the packages you updated in your commit message e.g.
[throttle] fix: setState was not called on the leading edge. - You've opened an issue prior to large or breaking changes. Talking about it first will increase the likelihood of merging.