You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As per slack conversation w/ @nditada, translation are often inadvertently making preventable mistakes (e.g. spaces between [] () in links and such). It is possible that some of these problems (and probably whole different set of others) could be discovered by having linter enabled for our md files.
I have tried to use markdownlint-cli (availabe via NPM) and it reveals a lot of issues, here's summary of errors it found across all MD files sorted by frequency:
We can obviously choose to opt-out from some of the rules if we don't think they can be easily adopted or that are not worth following (e.g. line length). Linter may fix some of these things automatically.
The text was updated successfully, but these errors were encountered:
I think it's a good idea provided we can set it as a post commit hook. We can't expect content contributors to set a linter up given in general we need to assume a life sciences background (AFAIK most people directly edits on GitHub).
As per slack conversation w/ @nditada, translation are often inadvertently making preventable mistakes (e.g. spaces between [] () in links and such). It is possible that some of these problems (and probably whole different set of others) could be discovered by having linter enabled for our md files.
I have tried to use markdownlint-cli (availabe via NPM) and it reveals a lot of issues, here's summary of errors it found across all MD files sorted by frequency:
1 MD037/no-space-in-emphasis 2 MD018/no-missing-space-atx 2 MD039/no-space-in-links 3 MD005/list-indent 4 MD019/no-multiple-space-atx 5 MD001/heading-increment/header-increment 8 MD032/blanks-around-lists 10 MD036/no-emphasis-as-heading/no-emphasis-as-header 11 MD024/no-duplicate-heading/no-duplicate-header 15 MD025/single-title/single-h1 21 MD045/no-alt-text 23 MD047/single-trailing-newline 38 MD033/no-inline-html 57 MD012/no-multiple-blanks 62 MD030/list-marker-space 67 MD034/no-bare-urls 83 MD007/ul-indent 101 MD026/no-trailing-punctuation 251 MD009/no-trailing-spaces 291 MD041/first-line-heading/first-line-h1 520 MD022/blanks-around-headings/blanks-around-headers 1021 MD013/line-length
We can obviously choose to opt-out from some of the rules if we don't think they can be easily adopted or that are not worth following (e.g. line length). Linter may fix some of these things automatically.
The text was updated successfully, but these errors were encountered: