[ENHANCEMENT] Criterion for document linting

indigo-dc / sqa-baseline

A set of Common Software Quality Assurance Baseline Criteria for Research Projects

Other

11 stars 3 forks source link

[ENHANCEMENT] Criterion for document linting #90

Closed orviz closed 2 years ago

orviz commented 2 years ago

Please elaborate here on the enhancement request. We need a criterion (or subcriterion) that recommends the use of linters for documentation markup languages.

Describe the solution you'd like Either under QC.Doc or QC.Sty, probably this needs further discussion

Additional context Examples of tools for doc-linting are markdownlint or restructuredtext-lint

orviz commented 2 years ago

The current workaround in SQAaaS is to use QC.Doc2.X

mariojmdavid commented 2 years ago

add as a SHOULD under DOC

mariojmdavid commented 2 years ago

added criterion QC.Doc2.2

mariojmdavid commented 2 years ago

release v4.1