CONTRIBUTING.md

Contributing rules

1 - Fork it!

2 - Clone

3 - Create your feature branch:

$ git checkout -b my-new-feature

4 - Write your feature unit tests

5 - Create your feature following the code style rules (Valid your code with ESLint) and document with jsdocs syntax:

Module documented with jsdocs example:

/**
 * Module description
 * @module moduleName
 * @param {string} paramName - Param description
 */
const moduleName = (param) => {
  console.log(param)
};

module.exports = moduleName;

Validate with eslint

$ npm run eslint

6 - Run the unit tests and calculate the coverage:

$ npm test

$ npm run cover

7 - Commit your changes:

$ git commit -m 'Add some feature'

8 - Push to the branch:

$ git push origin my-new-feature

6 - Submit a pull request