ci: add qlrd/pymarkdownlnt-gh-action to lint-docs workflow job #815
ci: add qlrd/pymarkdownlnt-gh-action to lint-docs workflow job #815qlrd wants to merge 1 commit into
Conversation
pymarkdownlnt to lint jobs
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #815 +/- ##
========================================
Coverage 97.30% 97.30%
========================================
Files 83 83
Lines 10798 10798
========================================
Hits 10507 10507
Misses 291 291 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
I think it's a great tool that contributors can spin locally and submit their results to the project. |
|
We can add only on CI then, or close |
|
I would repurpose the PR to lint files, the single one it targets now, or more, without adding weight to the project with tools and enforcements. It would be very welcome. |
7b0b8e3 to
9c74acc
Compare
`pymarkdownlnt` is a nice lib that lints markdown documents. It check for good formatting and standards managed by [CommonMark](https://spec.commonmark.org/); it runs only on CI and pass with warnings if fails.
Done |
pymarkdownlnt to lint jobs|
This PR still don't have lint changes to files. We can't designate Github actions without knowing the impact on CI, code and docs. First the changes must be done locally, then we can evaluate the tools that made it. |
What is this PR for?
pymarkdownlntis a nice lib that lints markdown documents. It check for good formatting and standards managed by CommonMark. As proof of concept, the linter was applied only to the README.md.Changes made to:
Did you build the code and tested on device?
What is the purpose of this pull request?