Skip to content
This repository has been archived by the owner on Oct 23, 2018. It is now read-only.

Latest commit

 

History

History
20 lines (13 loc) · 798 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (13 loc) · 798 Bytes
Raw

How to contribute

This project operates under a forking model. In order to contribute, please:

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes (adding tests).
  4. Add an entry in CHANGELOG.md.
  5. Submit a pull request (make sure to add a description explaining the changes).

Development

Run npm install to install the dependencies.

A pre-commit hook will lint the code and automatically fix some issues (and added to the commit). Linter can be executed manually running npm run lint.

To test the code, run npm test.

  • The command npm run test:watch runs the tests in watch mode (execution is triggered automatically when editing a test file).
  • The command npm run test:coverage generates the coverage report (in the coverage/ folder).