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

chore: lint http-gateways markdown #317

Closed
wants to merge 2 commits into from
Closed

Conversation

hacdias
Copy link
Member

@hacdias hacdias commented Sep 1, 2022

Procedure:

markdownlint *.md --disable MD013 --disable MD032 --fix

And some manual checks that are not automatically fixed by the linter.

@hacdias hacdias marked this pull request as ready for review September 1, 2022 19:38
@hacdias hacdias requested a review from lidel as a code owner September 1, 2022 19:38
@hacdias hacdias changed the title chore: lint PATH_GATEWAY.md chore: lint http-gateways markdown Sep 2, 2022
@hacdias hacdias marked this pull request as draft September 2, 2022 11:44
@hacdias hacdias marked this pull request as ready for review September 2, 2022 11:51
Copy link
Member

@SgtPooki SgtPooki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we modify the linter workflow so that these things are handled automatically in the future?

@hacdias
Copy link
Member Author

hacdias commented Oct 7, 2022

@SgtPooki we should. Right now, it seems the CI is only linting the files within the changed directory, giving the false impression that everything is fine when it isn't. That explains why the majority of the PRs are actually failing.

Merging main with the PR already brought a dozen of new errors, and there is no easy way to automatically fix them. I tried using the same tool as the CI with automatic fixing but it didn't fix half the issues.

@hacdias
Copy link
Member Author

hacdias commented Oct 12, 2022

I spoke to @lidel and it seems that the linting will be improved soon, as well as the way we present our specs. I'm closing this for now.

@hacdias hacdias closed this Oct 12, 2022
@hacdias hacdias deleted the chore/lint-path-gateway branch October 12, 2022 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants