This product welcomes contributions from the open source community. Firstly, please raise an issue on the repository, as this will be used to discuss/agree on scope and feature/bug detail. Once agreed, please follow the Development section to get started. Branch off main following logically branch naming conventions feature/*** or bug/***. When contributing please try and meet these development principles:
- This software product follows a module architecture, please try and stay consistent to making small, reusable
modulesof code within thelib/utilsdirectory. - Ensure any new code updated the relevant unit tests found within the
tests/directory. We use Jest for testing. - Make sure you run
npm run allbefore you push any changes to GitHub to ensure all tests, linting and building passes.
Once you are happy with the changes, please propose a pull request on the repository and the repository maintainers will review as soon as possible.