Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

69 lines (41 loc) · 1.87 KB

Contributing

Thank you for contributing. Here are some guidelines to get you started.

This project uses semantic commits and semver.

Follow these steps to get started:

  1. Make sure you have Node.js with npm installed

  2. Fork the repo into your account

  3. Clone the fork to your local machine

git clone https://github.com/<your-github-username>/react-r3f-shader-hook.git
  1. Install all the dependencies
cd react-r3f-shader-hook

npm install

Development

This project uses Storybook to help with the development.

You can start a Storybook development server by running the following in your terminal:

npm run storybook

Please make sure you add your stories in the designated stories directory

Testing

This project currently uses Jest for unit testing.

Run Jest test suites against the library with:

npm run jest

#or, to test live against changes
npm run jest:watch

We also use Cypress to help with testing. This is because, since this project involves in-depth usage of WebGL, Jest's JSDOM does not really support WebGLRenderer. Thus we need a proper browser environment to fully test the library. This is where Cypress comes in.

Run Cypress test suites against the library with:

npm run cypress

#or, to test live against changes using Cypress's interface
npx cypress open

Commiting your changes and creating a PR

Once you're done with your changes, you can commit them and open a PR. Please keep in mind this project uses semantic commits. If your PR closes an issue, please make sure to mention it in your commit footer.

Feel free to reach me at abshar.hassan7@gmail.com anytime.

Best of luck!