You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,22 +6,28 @@ We hold our code to standard, and these standards are documented below.
6
6
7
7
## Linters
8
8
9
-
We use prettier for automatic linting of all our files: `npm run lint:prettier`.
9
+
We use [prettier](https://prettier.io/) for automatic formatting a lot all our files. The configuration is in our `prettier.config.mjs` file.
10
10
11
-
### JavaScript: Run ESLint
11
+
To run prettier, use `npm run lint:prettier`.
12
12
13
-
We use [ESLint](https://eslint.org) on our JavaScript files.
13
+
### JavaScript: Run ESLint
14
14
15
-
The ESLint configuration is in our `eslint.config.mjs` file.
15
+
We use [ESLint](https://eslint.org) to lint our JavaScript files. The configuration is in our `eslint.config.mjs` file.
16
16
17
17
To run ESLint, use `npm run lint:js`.
18
18
19
19
### CSS: Run StyleLint
20
20
21
-
We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our `.stylelintrc` file.
21
+
We use [StyleLint](https://stylelint.io) to lint our CSS. The configuration is in our `.stylelintrc.json` file.
22
22
23
23
To run StyleLint, use `npm run lint:css`.
24
24
25
+
### Markdown: Run markdownlint
26
+
27
+
We use [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) to lint our markdown files. The configuration is in our `.markdownlint.json` file.
28
+
29
+
To run markdownlint, use `npm run markdownlint:css`.
30
+
25
31
## Testing
26
32
27
33
We use [Jest](https://jestjs.io) for JavaScript testing.
**MagicMirror²** is an open source modular smart mirror platform. With a growing list of installable modules, the **MagicMirror²** allows you to convert your hallway or bathroom mirror into your personal assistant. **MagicMirror²** is built by the creator of [the original MagicMirror](https://michaelteeuw.nl/tagged/magicmirror) with the incredible help of a [growing community of contributors](https://github.com/MagicMirrorOrg/MagicMirror/graphs/contributors).
@@ -24,7 +24,7 @@ For the full documentation including **[installation instructions](https://docs.
@@ -49,5 +49,5 @@ If we receive enough donations we might even be able to free up some working hou
49
49
To donate, please follow [this](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G5D8E9MR5DTD2&source=url) link.
50
50
51
51
<pstyle="text-align: center">
52
-
<a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>
52
+
<ahref="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><imgsrc="https://magicmirror.builders/img/magpi-best-watermark-custom.png"width="150"alt="MagPi Top 50"></a>
0 commit comments