Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I noticed that there is no linter enabled for the Markdown files. Thus, if you forget to add a proper heading at the top of a
md
file you'd be "ruining" theREADME
generation process.I added a workflow that triggers on PRs with very relaxed rules:
For a complete list of rules you can take a look over here.
Rules can be easily modified by changing the
.markdownlint
file.Led me know if you find this useful or if you think the rules should be different.
Thanks!