From 23a2d02f7f3a5b8750c2061e60d16156fe843d15 Mon Sep 17 00:00:00 2001 From: Norwid Behrnd Date: Wed, 30 Nov 2022 14:28:20 +0100 Subject: [PATCH] add hint to markdownlint In the longer term, the use of a linter (similar to pylint for Python) may contribute to easier maintenance of the markdown files and consistent display of the content on the web page. --- CONTRIBUTING.markdown | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index 3d2853c6..430ecea0 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -19,6 +19,9 @@ review them more effectively and/or individually. * **Keep lines under 80 chars** * Try to keep **line length in code blocks to 80 characters or fewer**. * Otherwise, the text will overflow and look odd. + * This and other potential pitfalls to format the content consistently are + identified by the freely available + [markdownlint](https://github.com/markdownlint/markdownlint). * **Prefer example to exposition** * Try to use as few words as possible. * Code examples are preferred over exposition in all cases.