ASVS icon indicating copy to clipboard operation
ASVS copied to clipboard

Enhancement: markdown linting on PR

Open tghosth opened this issue 3 years ago • 2 comments

It would be cool if there was something to lint our markdown when a PR is create.

(I am sure we used to have something built-in but I don't remember what it was and I can find no trace of it.)

Things it could check for:

  • Chapter and section headings in correct format
  • No issues with markdown table structure such as:
    • Correct number of columns
    • Correct spacing around text in table and in empty cells
  • Hyperlink format?
  • No hyperlinks in requirement text

Other things?

tghosth avatar Jun 22 '22 18:06 tghosth

from validation and "getting content in" process perspective I do this validation part from time to time.

To fix it entirely, we need to have content already in structured format, not in github md (similar to #1300)

elarlang avatar Jun 23 '22 06:06 elarlang

I am not sure I understand, the purpose of this specific issue is to make sure the github is in the correct format and that rogue spacing or issues don't appear. It would be great if there was a github action to do this on every PR. The other part relates to content of the output formats which would need to be manual and not a github action.

tghosth avatar Jun 23 '22 14:06 tghosth