mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-06-27 11:50:00 +00:00
Cleanup md files (#2994)
Update the issue template and the contributing guidelines Co-authored-by: veeck <michael@veeck.de>
This commit is contained in:
parent
a975b44fbb
commit
2908c15ea6
7
.github/CONTRIBUTING.md
vendored
7
.github/CONTRIBUTING.md
vendored
@ -6,7 +6,7 @@ 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.
|
||||
We use prettier for automatic linting of all our files: `npm run lint:prettier`.
|
||||
|
||||
### JavaScript: Run ESLint
|
||||
|
||||
@ -18,7 +18,7 @@ To run ESLint, use `npm run lint:js`.
|
||||
|
||||
### CSS: Run StyleLint
|
||||
|
||||
We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
|
||||
We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our `.stylelintrc` file.
|
||||
|
||||
To run StyleLint, use `npm run lint:css`.
|
||||
|
||||
@ -28,7 +28,8 @@ 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`.
|
||||
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
|
||||
|
||||
|
@ -14,6 +14,7 @@ _This release is scheduled to be released on 2023-04-01._
|
||||
### Updated
|
||||
|
||||
- Use develop as target branch for dependabot
|
||||
- Update issue template and contributing doc
|
||||
|
||||
### Fixed
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user