Contributing

Hi there,

Thank you for taking interest in this project, and thank you for considering making a contribution to this project.

Contributions are certainly welcome here!

Starting your contribution

When contributing to this repository, please first discuss the change you wish to make by creating an issue on the GitHub page:

For bug reports use this template.
For feature requests use this template.
For questions no template is required, but please be as informative as possible.

Pull Request Process

Once your contribution is ready to be added to the project, please do the following:

Ensure any install or build dependencies are removed before the end of the layer when doing a build.
Ensure linting standards are conformed to.
If new code is written, ensure that unit tests have been writen to cover the new code.
Update the changelog. Add details of your update to the appropriate section beneath "Unreleased". Our changelogs are based on KEEPACHANGELOG.
If required, update the README with details of changes to the interface.
Follow the Pull Request template. It is in place to make pull requests easier to review.
Assign jringram as a reviewer.
You may merge the Pull Request to DEVELOP once you have the sign-off of one other developer and all checks have passed.

Running the tests

npm run test to run jest tests.
npm run linter to run linter. This project uses SemiStandard styling.