-
Notifications
You must be signed in to change notification settings - Fork 2k
chore: add markdownlint on pre-commit hook and lint md files #996
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: add markdownlint on pre-commit hook and lint md files #996
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces markdownlint into the pre-commit workflow and applies linting fixes to markdown files to enforce consistent documentation style.
- Add
.markdownlint.yaml
with project-specific markdownlint rules. - Integrate
markdownlint-cli2
into.pre-commit-config.yaml
for automated markdown linting and fixing. - Adjust formatting across example READMEs and root docs (remove stray list markers, normalize blank lines, angle-bracket links).
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
.pre-commit-config.yaml | Added markdownlint-cli2 hook for markdown linting (--fix ). |
.markdownlint.yaml | Defined markdownlint rules (list style, indentation, line length, inline HTML, etc.). |
examples/servers/simple-streamablehttp/README.md | Removed stray list items and fixed blank-line spacing. |
examples/servers/simple-streamablehttp-stateless/README.md | Deleted extra blank list entries and corrected spacing. |
examples/servers/simple-auth/README.md | Normalized list markers, removed double-dash item, and added blank lines before sections. |
examples/clients/simple-chatbot/README.MD | Inserted blank lines around code and note blocks. |
SECURITY.md | Added blank line after the top-level heading. |
README.md | Added blank lines before code blocks and example lists. |
CODE_OF_CONDUCT.md | Wrapped email and URLs in angle brackets for link syntax. |
CLAUDE.md | Inserted blank lines around commit trailer examples. |
c958e8d
to
37eb86f
Compare
37eb86f
to
93cf83e
Compare
7ccf690
to
c9204f7
Compare
c9204f7
to
7efae07
Compare
@@ -542,6 +551,7 @@ async def handle_completion( | |||
|
|||
return None | |||
``` | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ihrpr Is this part generated from the examples script? can you add a new line there so we don't have this formatting it all the time?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find this useful. Mainly because my eyes always see those issues, and I don't want to annoy bringing them up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you
Thank you all for the reviews. |
Summary
Add markdownlint on pre-commit hook for linting and formatting markdown files
.markdownlint.yaml
: Added markdown linting rules with configurations for unordered list style, indentation, line length, inline HTML, and more..pre-commit-config.yaml
: Integratedmarkdownlint-cli2
into pre-commit hooks for automated markdown linting and fixing.Motivation and Context
To style all documentation files and ensure that everyone adheres to the same standards
How Has This Been Tested?
Run
pre-commit run --all-files
Types of changes
Checklist