[CI] Add pre-commit hook markdownlint with basic config#1391
Merged
Conversation
paulirwin
approved these changes
Jun 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Setup very basic config file with a lot of rules disabled.
https://github.com/davidanson/markdownlint#rules--aliases
Uses the Command Line Interface for markdownLint
https://github.com/igorshubovych/markdownlint-cli
Used on Apache Shiro and Airflow:
https://github.com/apache/shiro/blob/638d011a8e90ff500754b4d2f63b0746a2e3c624/.pre-commit-config.yaml#L102
https://github.com/apache/airflow/blob/6877aea6353cd0d54a622a6d7dcb4157888db060/.pre-commit-config.yaml#L1007
Using markdownlint within a pre-commit framework on GitHub prevents poorly formatted or broken documentation from entering your codebase by catching errors locally before code is pushed. It enforces stylistic consistency across files like README.md, turning manual style validation into an automated check.
Key Benefits