Contribution Policy for MagicMirror²

Thanks for contributing to MagicMirror²!

We hold our code to standard, and these standards are documented below.

First, before you run the linters, you will need to install them all and install the development dependencies:

(sudo) npm install -g jscs stylelint html-validator-cli
npm install

We use JSCS on our JavaScript files.

Our JSCS configuration is in our .jscsrc file.

To run JSCS, use npm run jscs.

We use StyleLint to lint our CSS. Our configuration is in our .stylelintrc file.

To run StyleLint, use npm run stylelint.

We use NU Validator to validate our HTML. The configuration is in the command in the package.json file.

To run HTML Validator, use npm run htmlvalidator.