mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-06-27 11:50:00 +00:00
9c9a5359dd
This PR will introduce different issue templates for bug reports, feature requests and so on on GitHub. There is still room for fine-tuning, but it's reached a state to show it to you and get feedback. I think that this can lead to better bug reports. You can see the result in my repo: https://github.com/KristjanESPERANTO/MagicMirror/issues/new/choose Feel free to create new issues for testing. What do you think? Do we want to pursue this further? # Conflicts: # CHANGELOG.md
39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
# Contribution Policy for MagicMirror²
|
|
|
|
Thanks for contributing to MagicMirror²!
|
|
|
|
We hold our code to standard, and these standards are documented below.
|
|
|
|
## Linters
|
|
|
|
We use [prettier](https://prettier.io/) for automatic formatting a lot all our files. The configuration is in our `prettier.config.mjs` file.
|
|
|
|
To run prettier, use `npm run lint:prettier`.
|
|
|
|
### JavaScript: Run ESLint
|
|
|
|
We use [ESLint](https://eslint.org) to lint our JavaScript files. The configuration is in our `eslint.config.mjs` file.
|
|
|
|
To run ESLint, use `npm run lint:js`.
|
|
|
|
### CSS: Run StyleLint
|
|
|
|
We use [StyleLint](https://stylelint.io) to lint our CSS. The configuration is in our `.stylelintrc.json` file.
|
|
|
|
To run StyleLint, use `npm run lint:css`.
|
|
|
|
### Markdown: Run markdownlint
|
|
|
|
We use [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) to lint our markdown files. The configuration is in our `.markdownlint.json` file.
|
|
|
|
To run markdownlint, use `npm run markdownlint:css`.
|
|
|
|
## 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`.
|