Contribution Guide
I'd be glad to see the support and pull requests from the community. Here's the guide:
- 1- Submit an issue for what you want to work on
- 2- After approval, fork the Github repository
- 3- Switch to the
develop
branch - 4- Start working! please remember to write tests for your changes.
- 5- Run
yarn build
and make sure everything is OK when runningyarn checkAll
. checkAll script checks the following items:- - Code formatting and styles using Eslint and Prettier
- - Tests all get passed
- - Coverage is 100%
- - Bundle size wouldn't exceed 9 KB
- 5- Submit a pull request(to develop branch of main repository), and we will work it out!