-
Notifications
You must be signed in to change notification settings - Fork 608
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
enable markdown linter #1210
Comments
For reference, see what I did for Umee:
|
Here was the old issue I had lol: #88 If people want to retry it, I'm happy to do so. But its the sort of thing I don't think we should feel too attached to / isn't really that helpful. I think the only ones I found helpful before were |
The linter will help us have consistency in our markdown, which IMO, is one of the most important things in any codebase, both docs & code wise. |
Drafted out a PR with this in #1317 to see how this works Tried running the linter and there were hundreds, maybe thousands of issues. Unfortunately, the linter doesn't auto-fix them all. After auto-fix, it still seems like a few hours worth of work to fix them all manually. One thing I also noted is that it would require further customization. For example, it complains about having headings with the same name in CHANGELOG What is the consensus on this? Should I keep working? I would like to make sure that the team wants this before I spend time Personally, I'm in support of encouraging consistency across the codebase but not sure if it's worth the time effort |
The only markdown lints I've found useful in the past limiting line lengths to 120 characters, and reminders for correct link syntax. I've otherwise found every other one counter-helpful. Taking unnecesasrry time review/iteration time for things like newline after heading, only using I'm happy to adapt if other people want to use it, I'm generally not enthused about them though |
Context
nit: we should have a markdown liner enabled
Originally posted by @alexanderbez in #1203 (comment)
Acceptance Criteria
The text was updated successfully, but these errors were encountered: