kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-27 19:53:36 +00:00
Code Issues Projects Releases Wiki Activity

Clean Up the Contributing Documentation and Process: Part I

Browse Source 
* Remove the HTML Validator
* Replace JSCS with ESLint
* Replace `npm` commands with equivalent `grunt` commands
This commit is contained in:
Nicholas Hubbard 2016-09-08 15:10:17 -04:00 committed by GitHub
parent c01c882081
commit 3cc186f7e4
1 changed files with 6 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
.github/CONTRIBUTING.md vendored
View File

@ -5,34 +5,21 @@ Thanks for contributing to MagicMirror²!
We hold our code to standard, and these standards are documented below. 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: ### JavaScript: Run ESLint
```bash We use [ESLint](http://eslint.org) on our JavaScript files.
(sudo) npm install -g jscs stylelint html-validator-cli
npm install
```
### JavaScript: Run JSCS Our ESLint configuration is in our .eslintrc.json and .eslintignore files.
We use [JSCS](http://jscs.info) on our JavaScript files. To run ESLint, use `grunt eslint`.
Our JSCS configuration is in our .jscsrc file.
To run JSCS, use `npm run jscs`.
### CSS: Run StyleLint ### CSS: Run StyleLint
We use [StyleLint](http://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file. We use [StyleLint](http://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
To run StyleLint, use `npm run stylelint`. To run StyleLint, use `grunt postcss:lint`.
### HTML: Run HTML Validator ### Submitting Issues
We use [NU Validator](https://validator.w3.org/nu) to validate our HTML. The configuration is in the command in the package.json file.
To run HTML Validator, use `npm run htmlvalidator`.
## Submitting Issues
Please only submit reproducible issues. Please only submit reproducible issues.