CONTRIBUTING.md

Contributing

Contributions are welcome and if you wish to make one you can just fork this repository, create a branch and submit a Pull request.

If you want to provide some feedback please reach out to us at: [email protected].

To report bugs or suggest new features, feel free to open an Issue, just so long as you adhere to the ordained format, that is displayed to you.

When submitting a Pull request, make sure to add tests that ensure your feature's completeness or bug resolution, and ensure that the Travis build passes.

Our selected testing framework is Jest and to execute the test suite just run the following command:

$ yarn test

You can also check the code coverage by running the following command:

$ yarn cover

This will output a summary of coverage data to the terminal and it will generate a more detailed coverage report that you can browse through, inside the coverage folder.

There's also a TDD script if you wish to run your code against the tests while developing. To do so, just run the following command:

$ yarn tdd