diff options
| author | Norwid Behrnd <nbehrnd@yahoo.com> | 2022-11-30 14:28:20 +0100 |
|---|---|---|
| committer | Norwid Behrnd <nbehrnd@yahoo.com> | 2022-11-30 14:28:20 +0100 |
| commit | 23a2d02f7f3a5b8750c2061e60d16156fe843d15 (patch) | |
| tree | 2bba58b2a87870d1167b1af20865d68847b6ea2b /CONTRIBUTING.markdown | |
| parent | eddf5accb885230940aa8d7c9a3375755d057e7b (diff) | |
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.
Diffstat (limited to 'CONTRIBUTING.markdown')
| -rw-r--r-- | CONTRIBUTING.markdown | 3 |
1 files changed, 3 insertions, 0 deletions
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. |