Enhancement: markdown linting on PR
Open
@vanderaj is already working on this.
Since Jun 22, 2022.
_5.0 - Not blocker
Community wanted
enhancement
- Dominant language
- HTML
- Stars
- 3.6k
- Forks
- 832
- Avg merge
- 7h 55m
- Merged PRs (30d)
- 4
Description
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?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.