Skip to content

Latest commit

 

History

History
58 lines (53 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

58 lines (53 loc) · 1.39 KB

Contributing

Local setup

  1. Fork the repo
  2. Clone the forked repo
$ git clone git@github.com:YOUR_USERNAME/react-http-fetch.git
  1. Install dependencies
$ cd react-http-fetch
$ yarn
  1. Link the local package:
$ yarn link
  1. Create a sandbox react app:
$ cd ..
$ create-react-app react-http-fetch-sandbox
$ cd react-http-fetch-sandbox
$ yarn
  1. Link the local library to the sanbox:
$ yarn link react-http-fetch
  1. Link react and react-dom:
$ yarn --cwd node_modules/react link
$ yarn --cwd node_modules/react-dom link
  1. Link react peer deps to local library:
$ cd ../react-http-fetch
$ yarn link react
$ yarn link react-dom
  1. Start library build in watch mode:
$ yarn build:watch
  1. In a second terminal window, start React app:
$ cd ../react-http-fetch-sandbox
$ yarn start

That's it! Now you can use the local library in your local sandbox. Any change to library source code should cause it to recompile and the sandbox app to refresh.

Test

Bu sure to cover any changes to the source code by integrating the tests suite.

Submit your changes

Push your changes against your forked repo and make a PR against nebarf/react-http-fetch:main.