-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Standardize Markdown headings; enforce MD003 with markdownlint #11688
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
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11688 +/- ##
============================================
- Coverage 17.56% 17.55% -0.01%
+ Complexity 15517 15515 -2
============================================
Files 5906 5906
Lines 528377 528377
Branches 64528 64528
============================================
- Hits 92783 92775 -8
- Misses 425162 425170 +8
Partials 10432 10432
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
no code touched @harikrishna-patnala , I think you can merge at will. |
|
ping @harikrishna-patnala ? |
vishesh92
left a comment
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.
lgtm
Description
This PR adds a check / test with markdownlint to make sure we only use one type of Markdown heading in our docs.
https://github.com/DavidAnson/markdownlint/blob/main/doc/md003.md
Use
.markdownlintignorefor better command line support. Central location and easy to find and maintainTypes of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Bug Severity
Screenshots (if appropriate):
How Has This Been Tested?
With pre-commit and visually checked
How did you try to break this feature and the system with this change?