We are pleased to receive any contribution by the community. By contributing to react-wasm, you agree to abide by the code of conduct.
Before opening an issue, please search the issue tracker to make sure your issue hasn’t already been reported. Please follow our guidelines when opening an issue, in that way we can understand your problem easily and we can help you faster.
Bugs and Improvements in general can be discussed on the issue tracker, make sure that there aren't other issues with the same purpose.
Visit the issue tracker to find a list of open issues that need attention.
Fork, then clone the repo:
git clone https://github.com/mbasso/react-wasm.git
Running the build task will create both a CommonJS module-per-module build and a UMD build.
npm run build
To create just a CommonJS module-per-module build:
npm run build:commonjs
The result will be in the lib folder.
To create just a UMD build:
npm run build:umd
npm run build:umd:min
The result will be in the dist folder.
To run both linting and testing at once, run the following:
npm run check:src
To only run linting:
npm run lint
To only run tests:
npm test
Improvements to the documentation are always welcome. Before submitting your changes, check that they respect all docs style. For example, use "-" for lists etc.
Pull requests are welcome, but make sure that your changes respect the 2 points in PR template:
- Pull request has tests / docs demo, and is linted.
- Description explains the issue / use-case resolved, and auto-closes the related issue(s)
Thank you!