Skip to content

Commit

Permalink
Merge pull request #2751 from KristjanESPERANTO/patch-1
Browse files Browse the repository at this point in the history
Add End-to-End Testing + Format
  • Loading branch information
MichMich authored Dec 28, 2021
2 parents 4ad832d + 855860c commit c4d2a7b
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ Thanks for contributing to MagicMirror²!

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

## Linters

If you wish to run our linters, use `npm run lint` without any arguments.

### JavaScript: Run ESLint

We use [ESLint](https://eslint.org) on our JavaScript files.

Our ESLint configuration is in our .eslintrc.json and .eslintignore files.
Our ESLint configuration is in our `.eslintrc.json` and `.eslintignore` files.

To run ESLint, use `npm run lint:js`.

Expand All @@ -20,7 +22,15 @@ We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is i

To run StyleLint, use `npm run lint:css`.

### Submitting Issues
## Testing

We use [Jest](https://jestjs.io) for JavaScript testing.

To run all tests, use `npm run test`.

The specific test commands are defined in `package.json`. So you can also run the specific tests with other commands, e.g. `npm run test:unit` or `npx jest tests/e2e/env_spec.js`.

## Submitting Issues

Please only submit reproducible issues.

Expand Down

0 comments on commit c4d2a7b

Please sign in to comment.