Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce markdown linter to CI #1940

Closed
uhbif19 opened this issue Mar 11, 2021 · 1 comment · Fixed by #2215
Closed

Introduce markdown linter to CI #1940

uhbif19 opened this issue Mar 11, 2021 · 1 comment · Fixed by #2215
Labels
feature New feature or request good first issue Entrypoint to the project help wanted Extra attention is needed level:starter Good for newcomers

Comments

@uhbif19
Copy link
Contributor

uhbif19 commented Mar 11, 2021

Thesis

I propose adding markdown linter to project CI. Initial discussion was here.

One possibility is to add it to Makefile, the second is to add github action, as was suggested here.

Also, there is a question which rules to enable. Linter could check all rules that not warn on current markdown state or enable just some selected rules.

Reasoning

There is at least one rule of writing project MD files that can be checked by linter, but is checked manually now.
Using linter will reduce toil.

@sobolevn
Copy link
Member

@uhbif19 you are more than welcome! 👍

The only thing to keep in mind: it should adapt to existing spoken rules.

@sobolevn sobolevn added feature New feature or request good first issue Entrypoint to the project help wanted Extra attention is needed level:starter Good for newcomers labels Mar 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request good first issue Entrypoint to the project help wanted Extra attention is needed level:starter Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants