From ec1f15ed0448186b73c568f608a1ba0d4905c75c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Seidel?= Date: Tue, 16 Jul 2024 14:07:50 +0200 Subject: [PATCH] add contribution --- Readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Readme.md b/Readme.md index 4c7ddee..060038b 100644 --- a/Readme.md +++ b/Readme.md @@ -73,6 +73,15 @@ To change the IP address for the debugging, open the file `./vscode/launch.json` Thanks for your interest in contributing. Anybody is free to report bugs, unclear documentation, and other problems regarding this repository in the Issues section or, even better, is free to propose any changes to this repository using Merge Requests. +### Markdownlint-cli + +This workspace will be checked by the [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) (there is also documented ho to install the tool) tool in the CI workflow automatically. +To avoid, that the CI workflow fails because of the markdown linter, you can check all markdown files locally by running the markdownlint with: + +```sh +markdownlint **/*.md --fix +``` + ## License and Legal information Please read the [Legal information](LICENSE.md)