Contributing
Thank you for considering contributing to our project. Your help if very welcome!
When contributing, it's better to first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
All members of our community are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly in all of our spaces.
Getting started
In order to make your contribution please make a fork of the repository. After you've pulled the code, follow these steps to kick start the development:
Run
npm i
to install dependenciesRun
npm start
to launch demo project where you could test your changesUse following commands to ensure code quality
Pull Request Process
We follow Conventional Commits
in our commit messages, i.e.
feat(core): improve typing
Update README.md to reflect changes related to public API and everything relevant
Make sure you cover all code changes with unit tests
When you are ready, create Pull Request of your fork into original repository
Last updated