Skip to content

Conversation

@jbampton
Copy link
Member

Did you read the Contributor Guide?

Is this PR related to a JIRA ticket?

What changes were proposed in this PR?

This pr adds another hook to our pre-commit framework to check the Markdown files.

https://github.com/igorshubovych/markdownlint-cli#use-with-pre-commit

https://github.com/DavidAnson/markdownlint

I have disabled a whole bunch of rules.

Going forwards we can work on our "Markdown" files and standardize them.

How was this patch tested?

pre-commit run --all-files

or

pre-commit run markdownlint --all-files

Did this PR include necessary documentation updates?

  • No, this PR does not affect any public API so no need to change the docs.

@jiayuasu jiayuasu merged commit 8cbe4f8 into apache:master Dec 13, 2023
@jbampton jbampton deleted the add-markdownlint-with-pre-commit branch December 13, 2023 17:07
Kontinuation pushed a commit to Kontinuation/sedona that referenced this pull request Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants