Want to contribute? Awesome. We love contributors.
Fork then clone the repo:
git clone [email protected]:your-username/react-spinners.git
Create a new branch:
git checkout -b awesome-feature
Install the necessary dependencies (you can use npm
or yarn
):
npm install
After finishing your feature, to update the dist
folder, you can run:
npm run prepublish
If you want to make changes to the demo page, you can edit the files in examples
and docs
folder.
To see the changes, you can use webpack
to update the bundle file.
npm run watch
Make or add changes, commit your changes:
git add -A;
git commit -m 'Awesome new feature';
Make sure to run the necessary tests and lints and fix any errors:
npm run lintfix;
Push up to Github:
git push origin awesome-feature;
Create a Pull Request, add appropriate label(s).
Congratulations! You are done. Just wait for us to review your code.
Please click here to report an issue or request a new feature.