Contributor Guidelines

How to file a bug report

Create a new issue
Select the Bug Report template
Provide clear and descriptive information

How to suggest a new feature

Create a new issue
Select the Feature Request template
Provide detailed explanation of the feature
Be open to discussions on the feature idea

How to submit a pull request (and what happens next)

Fork the repository
Clone the fork and create a new branch for you changes
If possible, make sure your changes are covered by tests
Submit a pull request from you branch to the main repository
Provide a clear description of the changes

After submitting a pull request:

A member will review the request, and you may need to make changes
Your code will be tested automatically by Snyk and by a member of the group.

How to set up your environment and run tests

Fork the repository
Clone the fork and create a new branch for your changes
Install dependencies by running 'npm install'
Run tests
Start coding

Types of contributions the project is looking for

We are looking for the following types of contributions:

New features
Bug fixes
Documentation improvements

We are not looking for:

Large refactors without a discussion

Technical requirements for contributions

Testing: If possible, all code contributions include tests
Style Guidelines: Please follow the JavaScript Style Guide at:
- https://www.w3schools.com/js/js_conventions.asp
Documentation: Ensure any new features or changes are documented

Your roadmap or vision for the project

To understand where this project is heading, take a look at our project proposal: https://docs.google.com/document/d/1sQZUjjkCNwvpSUFfT6f2ajvL3CHVJje5Iorgev7QpO4/edit#heading=h.t2la2pq0vb65

Project ground rules and expected behaviour

Please read our Code of Conduct

How contributors should (or should not) get in touch with you