diff --git a/README.md b/README.md index ffc6ecfcae..ed0a61347e 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,8 @@ CD in your Terminal to the root directory of the cloned repository. Install all npm install npm start ``` + +## Linting problems + +The repository establishes commit hooks which check the files for correctness and style. +Have a look at the [linting-guide](https://docs.scs.community/community/contribute/linting-guide/) to get detailed information. diff --git a/community/contribute/linting-guide.md b/community/contribute/linting-guide.md index 41ad7838d5..07f427155d 100644 --- a/community/contribute/linting-guide.md +++ b/community/contribute/linting-guide.md @@ -21,6 +21,13 @@ The markdownlint rules are defined in the configuration file `.markdownlint-cli2 Additionally we use [markdownlint-rule-search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) for fixing +## Local Usage for development + +```bash +npm run lint:md +npm run fix:md +``` + ## Github Workflows There are two actions running on every Pull Request on the `main` branch.