CONTRIBUTING.md

Contribution Guidelines

All code contributions shall be made using the MIT license.

• Contribution Guidelines
  • Guide
  • Running locally

Guide

Please ensure pull requests adheres to the following guidelines:

• Search previous pull requests before making a new one, as yours may be a duplicate.
• Make sure your code style matches existing code. Soft tabs=4, no trailing spaces etc.
• Make an individual pull request for each change. No monolithic pull requests please.
• Work constructively with project maintainers to refine your pull request if requested.

Running locally

Contributions are encouraged via forked pull requests.

To setup the project locally run:

npm install

You can run the test suite locally with:

npm test

You can run the linter with:

npm run lint