Skip to content

Commit 02da010

Browse files
authored
Improve documentation for linting (#267)
Signed-off-by: Marc Schöchlin <[email protected]>
1 parent 2f5b1ce commit 02da010

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,8 @@ CD in your Terminal to the root directory of the cloned repository. Install all
2626
npm install
2727
npm start
2828
```
29+
30+
## Linting problems
31+
32+
The repository establishes commit hooks which check the files for correctness and style.
33+
Have a look at the [linting-guide](https://docs.scs.community/community/contribute/linting-guide/) to get detailed information.

community/contribute/linting-guide.md

+7
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ The markdownlint rules are defined in the configuration file `.markdownlint-cli2
2121

2222
Additionally we use [markdownlint-rule-search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) for fixing
2323

24+
## Local Usage for development
25+
26+
```bash
27+
npm run lint:md <file>
28+
npm run fix:md <file>
29+
```
30+
2431
## Github Workflows
2532

2633
There are two actions running on every Pull Request on the `main` branch.

0 commit comments

Comments
 (0)