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

Add dev instructions of how to run the Markdown linter locally #46

Closed
aevo98765 opened this issue Jul 8, 2024 · 4 comments
Closed

Add dev instructions of how to run the Markdown linter locally #46

aevo98765 opened this issue Jul 8, 2024 · 4 comments
Assignees

Comments

@aevo98765
Copy link
Member

I made changes to a MD file and found that the CI pipeline failed because of the Markdown linter. I didn't know how to run this locally on my machine which would make it easier to correct these linting issues.

Acceptance Criteria:

Add instructions of what tool and how to install the Markdown linter locally for devs to run checks before pushing remotely.

@vishnoianil
Copy link
Member

@aevo98765 in the makefile, there is a target md-lint that runs the linter locally. That didn't work for you?

@aevo98765
Copy link
Member Author

Hey @vishnoianil, ahh I haven't been using the Makefile in this project. Do we think it is worth having instructions of how to run the MD linter outside of the Makefile or just comment to use the Makefile if you want to run the linting checks... or... just close this issue off as not needed?

@vishnoianil
Copy link
Member

@aevo98765 in my opinion, let's stick with makefile as of now, we can always change if that's not working for folks. Having documented it somewhere that dev can use md-lint target to lint the markdown files would be awesome.

@aevo98765
Copy link
Member Author

aevo98765 commented Jul 15, 2024

#75 @vishnoianil

@aevo98765 aevo98765 self-assigned this Jul 15, 2024
vishnoianil added a commit that referenced this issue Jul 16, 2024
…markdown-linting

Instructions for dev markdown file linting
@aevo98765 aevo98765 closed this as completed by moving to Done in UI Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants