Merge pull request #135 from imcf/gha-markdownlint

Add a job to the linting workflow running the [markdownlint-cli2-action][1].

While at it:

- rule out `markdownlint`'s complaints
- apply a few spelling fixes
- extend the spelling dictionary

[1]: https://github.com/marketplace/actions/markdownlint-cli2-action

Author: ehrenfeu

.github/workflows/lint.yml

@@ -1,23 +1,36 @@
-name: Code Linting 🔎⚡
+name: Linting 📑🔎⚡
 
 on:
   push:
   pull_request:
   workflow_dispatch:
 
 jobs:
-
-  lint:
+  ruff:
     name: Ruff ⚡🕵
 
     runs-on: ubuntu-latest
 
     steps:
-
       - name: 📥 Checkout repo
         uses: actions/checkout@v4
 
       - name: Run Ruff checks ⚡
         uses: astral-sh/ruff-action@v3
         with:
           args: check
+
+  markdownlint:
+    name: Markdownlint 📑🕵
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📥 Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Run markdownlint-cli2-action 📑
+        uses: DavidAnson/markdownlint-cli2-action@v22
+        with:
+          globs: |
+            *.md
+            !test/*.md

.vscode/settings.json

@@ -15,31 +15,56 @@
         "bdvp",
         "bigstitcher",
         "biop",
+        "clij",
+        "Dscijava",
+        "flatfield",
+        "Fluo",
+        "IJPB",
         "imageplus",
+        "imarisconvert",
         "imglib",
+        "imgplus",
         "interestpoint",
         "intermodes",
         "javax",
+        "keyvalue",
         "Kheops",
+        "labelimage",
+        "listdir",
         "micrometa",
+        "Morpholib",
         "multiresolution",
+        "olefile",
+        "omerotools",
+        "ordereddict",
         "otsu",
         "pathtools",
+        "phmax",
         "Prefs",
+        "processingoptions",
         "PTBIOP",
         "PYENV",
         "pylint",
         "ransac",
         "renyi",
         "repartitions",
+        "resultstable",
         "RETVAL",
+        "roimanager",
+        "rois",
+        "rollingball",
         "scijava",
         "shanbhag",
         "sjlogging",
+        "smtpserver",
         "spimdata",
+        "stardist",
+        "stdv",
         "strtools",
         "subfolders",
         "subsampling",
+        "TESTDATA",
+        "thresholding",
         "trackmate",
         "virtualenv",
         "virtualfish"

DESC.md

@@ -1,2 +1,4 @@
+<!-- markdownlint-disable MD041 (first-line-heading) -->
+
 :snake::coffee::nut_and_bolt::wrench:
 A collection of commonly used Python helper functions.

TESTING.md

@@ -6,9 +6,9 @@ Those parts of the package that do not interact / depend on ImageJ objects can
 be tested via [`pytest`][pytest] up to a certain level, some (most?) of them
 should even work in a Python 3 environment.
 
-To perform those tests, the packges otherwise provided by ImageJ need to be
-mocked using the `imcf-fiji-mocks` package. For seting up a *venv* use the steps
-described here:
+To perform those tests, the packages otherwise provided by ImageJ need to be
+mocked using the `imcf-fiji-mocks` package. For setting up a *venv* use the
+steps described here:
 
 ```bash
 # check if we're "inside" the repo already, otherwise clone it here: